diff options
| 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 | |
| parent | 1a79b20663ca26acc2998b90ea2ff2aefd8af5b1 (diff) | |
Diffstat (limited to 'doc/html/appdev/refs/api')
373 files changed, 13254 insertions, 17978 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 — 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 /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_425_conv_principal.html b/doc/html/appdev/refs/api/krb5_425_conv_principal.html index 5365466cc9af..036e97f21d51 100644 --- a/doc/html/appdev/refs/api/krb5_425_conv_principal.html +++ b/doc/html/appdev/refs/api/krb5_425_conv_principal.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_425_conv_principal - Convert a Kerberos V4 principal to a Kerberos V5 principal. — 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_524_conv_principal - Convert a Kerberos V5 principal to a Kerberos V4 principal." href="krb5_524_conv_principal.html" /> <link rel="prev" title="krb5_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data." href="krb5_verify_authdata_kdc_issued.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-425-conv-principal-convert-a-kerberos-v4-principal-to-a-kerberos-v5-principal"> + <section id="krb5-425-conv-principal-convert-a-kerberos-v4-principal-to-a-kerberos-v5-principal"> <h1>krb5_425_conv_principal - Convert a Kerberos V4 principal to a Kerberos V5 principal.<a class="headerlink" href="#krb5-425-conv-principal-convert-a-kerberos-v4-principal-to-a-kerberos-v5-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_425_conv_principal"> -<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_425_conv_principal</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 char *<em> name</em>, const char *<em> instance</em>, const char *<em> realm</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_425_conv_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_425_conv_principal"> +<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_425_conv_principal</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">instance</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_425_conv_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>name</strong> - V4 name</p> <p><strong>[in]</strong> <strong>instance</strong> - V4 instance</p> <p><strong>[in]</strong> <strong>realm</strong> - Realm</p> -<p class="last"><strong>[out]</strong> <strong>princ</strong> - V5 principal</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>princ</strong> - V5 principal</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 builds a <em>princ</em> from V4 specification based on given input <em>name.instance@realm</em> .</p> -<p>Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>princ</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_principal() to free <em>princ</em> when it is no longer needed.</p> +</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_425_conv_principal - Convert a Kerberos V4 principal to a Kerberos V5 principal.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_524_conv_principal.html b/doc/html/appdev/refs/api/krb5_524_conv_principal.html index e37a27edcb7f..3d67076abde9 100644 --- a/doc/html/appdev/refs/api/krb5_524_conv_principal.html +++ b/doc/html/appdev/refs/api/krb5_524_conv_principal.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_524_conv_principal - Convert a Kerberos V5 principal to a Kerberos V4 principal. — 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_address_compare - Compare two Kerberos addresses." href="krb5_address_compare.html" /> <link rel="prev" title="krb5_425_conv_principal - Convert a Kerberos V4 principal to a Kerberos V5 principal." href="krb5_425_conv_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-524-conv-principal-convert-a-kerberos-v5-principal-to-a-kerberos-v4-principal"> + <section id="krb5-524-conv-principal-convert-a-kerberos-v5-principal-to-a-kerberos-v4-principal"> <h1>krb5_524_conv_principal - Convert a Kerberos V5 principal to a Kerberos V4 principal.<a class="headerlink" href="#krb5-524-conv-principal-convert-a-kerberos-v5-principal-to-a-kerberos-v4-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_524_conv_principal"> -<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_524_conv_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ</em>, char *<em> name</em>, char *<em> inst</em>, char *<em> realm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_524_conv_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_524_conv_principal"> +<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_524_conv_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">inst</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_524_conv_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>princ</strong> - V5 Principal</p> <p><strong>[out]</strong> <strong>name</strong> - V4 principal’s name to be filled in</p> <p><strong>[out]</strong> <strong>inst</strong> - V4 principal’s instance name to be filled in</p> -<p class="last"><strong>[out]</strong> <strong>realm</strong> - Principal’s realm name to be filled in</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 simple"> -<li>0 Success</li> -<li>KRB5_INVALID_PRINCIPAL Invalid principal name</li> -<li>KRB5_CONFIG_CANTOPEN Can’t open or find Kerberos configuration file</li> +<p><strong>[out]</strong> <strong>realm</strong> - Principal’s realm name to be filled in</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</p></li> +<li><p>KRB5_INVALID_PRINCIPAL Invalid principal name</p></li> +<li><p>KRB5_CONFIG_CANTOPEN Can’t open or find Kerberos configuration file</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function separates a V5 principal <em>princ</em> into <em>name</em> , <em>instance</em> , and <em>realm</em> .</p> -</div> +</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_524_conv_principal - Convert a Kerberos V5 principal to a Kerberos V4 principal.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_524_convert_creds.html b/doc/html/appdev/refs/api/krb5_524_convert_creds.html index 5f0e6bac2ecf..1e0e7f03ce19 100644 --- a/doc/html/appdev/refs/api/krb5_524_convert_creds.html +++ b/doc/html/appdev/refs/api/krb5_524_convert_creds.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_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials. — 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_auth_con_getlocalsubkey" href="krb5_auth_con_getlocalsubkey.html" /> <link rel="prev" title="krb5_sendauth - Client function for sendauth protocol." href="krb5_sendauth.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-524-convert-creds-convert-a-kerberos-v5-credentials-to-a-kerberos-v4-credentials"> + <section id="krb5-524-convert-creds-convert-a-kerberos-v5-credentials-to-a-kerberos-v4-credentials"> <h1>krb5_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials.<a class="headerlink" href="#krb5-524-convert-creds-convert-a-kerberos-v5-credentials-to-a-kerberos-v4-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_524_convert_creds"> -int <code class="descname">krb5_524_convert_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> v5creds</em>, struct credentials *<em> v4creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_524_convert_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_524_convert_creds"> +<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_524_convert_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">v5creds</span></span>, <span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">credentials</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">v4creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_524_convert_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>v5creds</strong></p> -<p class="last"><strong>v4creds</strong></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>KRB524_KRB4_DISABLED (always)</li> +<p><strong>v4creds</strong></p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>KRB524_KRB4_DISABLED (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Not implemented</p> -</div> +<p class="admonition-title">Note</p> +<p>Not implemented</p> </div> +</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_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials.</a></li> @@ -145,6 +130,7 @@ int <code class="descname">krb5_524_convert_creds</code><span class="sig-paren"> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ int <code class="descname">krb5_524_convert_creds</code><span class="sig-paren"> <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_address_compare.html b/doc/html/appdev/refs/api/krb5_address_compare.html index 728547fdaccd..61566692c130 100644 --- a/doc/html/appdev/refs/api/krb5_address_compare.html +++ b/doc/html/appdev/refs/api/krb5_address_compare.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_address_compare - Compare two Kerberos addresses. — 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_address_order - Return an ordering of the specified addresses." href="krb5_address_order.html" /> <link rel="prev" title="krb5_524_conv_principal - Convert a Kerberos V5 principal to a Kerberos V4 principal." href="krb5_524_conv_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-address-compare-compare-two-kerberos-addresses"> + <section id="krb5-address-compare-compare-two-kerberos-addresses"> <h1>krb5_address_compare - Compare two Kerberos addresses.<a class="headerlink" href="#krb5-address-compare-compare-two-kerberos-addresses" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_address_compare"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_address_compare</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_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> addr1</em>, const <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> addr2</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_compare" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_address_compare"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_address_compare</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_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr1</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr2</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_compare" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>addr1</strong> - First address to be compared</p> -<p class="last"><strong>[in]</strong> <strong>addr2</strong> - Second address to be compared</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if the addresses are the same, FALSE otherwise</li> +<p><strong>[in]</strong> <strong>addr2</strong> - Second address to be compared</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the addresses are the same, FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_address_compare - Compare two Kerberos addresses.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_address_order.html b/doc/html/appdev/refs/api/krb5_address_order.html index 76870640393c..aee5c35c472e 100644 --- a/doc/html/appdev/refs/api/krb5_address_order.html +++ b/doc/html/appdev/refs/api/krb5_address_order.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_address_order - Return an ordering of the specified addresses. — 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_address_search - Search a list of addresses for a specified address." href="krb5_address_search.html" /> <link rel="prev" title="krb5_address_compare - Compare two Kerberos addresses." href="krb5_address_compare.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-address-order-return-an-ordering-of-the-specified-addresses"> + <section id="krb5-address-order-return-an-ordering-of-the-specified-addresses"> <h1>krb5_address_order - Return an ordering of the specified addresses.<a class="headerlink" href="#krb5-address-order-return-an-ordering-of-the-specified-addresses" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_address_order"> -int <code class="descname">krb5_address_order</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_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> addr1</em>, const <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> addr2</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_order" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_address_order"> +<span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_address_order</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_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr1</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr2</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_order" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>addr1</strong> - First address</p> -<p class="last"><strong>[in]</strong> <strong>addr2</strong> - Second address</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 if The two addresses are the same</li> -<li>< 0 First address is less than second</li> -<li>> 0 First address is greater than second</li> +<p><strong>[in]</strong> <strong>addr2</strong> - Second address</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 if The two addresses are the same</p></li> +<li><p>< 0 First address is less than second</p></li> +<li><p>> 0 First address is greater than second</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_address_order - Return an ordering of the specified addresses.</a></li> @@ -143,6 +128,7 @@ int <code class="descname">krb5_address_order</code><span class="sig-paren">(</s <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ int <code class="descname">krb5_address_order</code><span class="sig-paren">(</s <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_address_search.html b/doc/html/appdev/refs/api/krb5_address_search.html index 2248695cbec2..842da1576beb 100644 --- a/doc/html/appdev/refs/api/krb5_address_search.html +++ b/doc/html/appdev/refs/api/krb5_address_search.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_address_search - Search a list of addresses for a specified address. — 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_allow_weak_crypto - Allow the application to override the profile’s allow_weak_crypto setting." href="krb5_allow_weak_crypto.html" /> <link rel="prev" title="krb5_address_order - Return an ordering of the specified addresses." href="krb5_address_order.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-address-search-search-a-list-of-addresses-for-a-specified-address"> + <section id="krb5-address-search-search-a-list-of-addresses-for-a-specified-address"> <h1>krb5_address_search - Search a list of addresses for a specified address.<a class="headerlink" href="#krb5-address-search-search-a-list-of-addresses-for-a-specified-address" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_address_search"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_address_search</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_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> addr</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *const *<em> addrlist</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_search" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_address_search"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_address_search</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_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addrlist</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_address_search" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>addr</strong> - Address to search for</p> -<p class="last"><strong>[in]</strong> <strong>addrlist</strong> - Address list to be searched (or NULL)</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if addr is listed in addrlist , or addrlist is NULL; FALSE otherwise</li> +<p><strong>[in]</strong> <strong>addrlist</strong> - Address list to be searched (or NULL)</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if addr is listed in addrlist , or addrlist is NULL; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If <em>addrlist</em> contains only a NetBIOS addresses, it will be treated as a null list.</p> -</div> +<p class="admonition-title">Note</p> +<p>If <em>addrlist</em> contains only a NetBIOS addresses, it will be treated as a null list.</p> </div> +</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_address_search - Search a list of addresses for a specified address.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_allow_weak_crypto.html b/doc/html/appdev/refs/api/krb5_allow_weak_crypto.html index bcf63f3cc111..2f0509f5ef30 100644 --- a/doc/html/appdev/refs/api/krb5_allow_weak_crypto.html +++ b/doc/html/appdev/refs/api/krb5_allow_weak_crypto.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_allow_weak_crypto - Allow the application to override the profile’s allow_weak_crypto setting. — 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_aname_to_localname - Convert a principal name to a local name." href="krb5_aname_to_localname.html" /> <link rel="prev" title="krb5_address_search - Search a list of addresses for a specified address." href="krb5_address_search.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-allow-weak-crypto-allow-the-application-to-override-the-profile-s-allow-weak-crypto-setting"> + <section id="krb5-allow-weak-crypto-allow-the-application-to-override-the-profile-s-allow-weak-crypto-setting"> <h1>krb5_allow_weak_crypto - Allow the application to override the profile’s allow_weak_crypto setting.<a class="headerlink" href="#krb5-allow-weak-crypto-allow-the-application-to-override-the-profile-s-allow-weak-crypto-setting" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_allow_weak_crypto"> -<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_allow_weak_crypto</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>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> enable</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_allow_weak_crypto" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_allow_weak_crypto"> +<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_allow_weak_crypto</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>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">enable</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_allow_weak_crypto" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>enable</strong> - Boolean flag</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 (always)</li> +<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>enable</strong> - Boolean flag</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function allows an application to override the allow_weak_crypto setting. It is primarily for use by aklog.</p> -</div> +</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_allow_weak_crypto - Allow the application to override the profile’s allow_weak_crypto setting.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_aname_to_localname.html b/doc/html/appdev/refs/api/krb5_aname_to_localname.html index 30634f20b2de..f3bd88ec1d12 100644 --- a/doc/html/appdev/refs/api/krb5_aname_to_localname.html +++ b/doc/html/appdev/refs/api/krb5_aname_to_localname.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_aname_to_localname - Convert a principal name to a local name. — 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_anonymous_principal - Build an anonymous principal." href="krb5_anonymous_principal.html" /> <link rel="prev" title="krb5_allow_weak_crypto - Allow the application to override the profile’s allow_weak_crypto setting." href="krb5_allow_weak_crypto.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-aname-to-localname-convert-a-principal-name-to-a-local-name"> + <section id="krb5-aname-to-localname-convert-a-principal-name-to-a-local-name"> <h1>krb5_aname_to_localname - Convert a principal name to a local name.<a class="headerlink" href="#krb5-aname-to-localname-convert-a-principal-name-to-a-local-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_aname_to_localname"> -<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_aname_to_localname</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> aname</em>, int<em> lnsize_in</em>, char *<em> lname</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_aname_to_localname" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_aname_to_localname"> +<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_aname_to_localname</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">aname</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">lnsize_in</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">lname</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_aname_to_localname" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>aname</strong> - Principal name</p> <p><strong>[in]</strong> <strong>lnsize_in</strong> - Space available in <em>lname</em></p> -<p class="last"><strong>[out]</strong> <strong>lname</strong> - Local name buffer to be filled in</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 simple"> -<li>0 Success</li> -<li>System errors</li> +<p><strong>[out]</strong> <strong>lname</strong> - Local name buffer to be filled in</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</p></li> +<li><p>System errors</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>If <em>aname</em> does not correspond to any local account, KRB5_LNAME_NOTRANS is returned. If <em>lnsize_in</em> is too small for the local name, KRB5_CONFIG_NOTENUFSPACE is returned.</p> <p>Local names, rather than principal names, can be used by programs that translate to an environment-specific name (for example, a user account name).</p> -</div> +</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_aname_to_localname - Convert a principal name to a local name.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_anonymous_principal.html b/doc/html/appdev/refs/api/krb5_anonymous_principal.html index 6af7c26dfebc..43176b16c2fb 100644 --- a/doc/html/appdev/refs/api/krb5_anonymous_principal.html +++ b/doc/html/appdev/refs/api/krb5_anonymous_principal.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_anonymous_principal - Build an anonymous principal. — 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_anonymous_realm - Return an anonymous realm data." href="krb5_anonymous_realm.html" /> <link rel="prev" title="krb5_aname_to_localname - Convert a principal name to a local name." href="krb5_aname_to_localname.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-anonymous-principal-build-an-anonymous-principal"> + <section id="krb5-anonymous-principal-build-an-anonymous-principal"> <h1>krb5_anonymous_principal - Build an anonymous principal.<a class="headerlink" href="#krb5-anonymous-principal-build-an-anonymous-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_anonymous_principal"> -<a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a> <code class="descname">krb5_anonymous_principal</code><span class="sig-paren">(</span>void<em> None</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_anonymous_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_anonymous_principal"> +<a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_anonymous_principal</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_anonymous_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>None</strong></td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>None</strong></p> +</dd> +</dl> <p>This function returns constant storage that must not be freed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="../macros/KRB5_ANONYMOUS_PRINCSTR.html#KRB5_ANONYMOUS_PRINCSTR" title="KRB5_ANONYMOUS_PRINCSTR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_ANONYMOUS_PRINCSTR</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>#KRB5_ANONYMOUS_PRINCSTR</p> </div> +</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_anonymous_principal - Build an anonymous principal.</a></li> @@ -132,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_anonymous_realm.html b/doc/html/appdev/refs/api/krb5_anonymous_realm.html index 9d71af228e14..912343ef6322 100644 --- a/doc/html/appdev/refs/api/krb5_anonymous_realm.html +++ b/doc/html/appdev/refs/api/krb5_anonymous_realm.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_anonymous_realm - Return an anonymous realm data. — 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_appdefault_boolean - Retrieve a boolean value from the appdefaults section of krb5.conf." href="krb5_appdefault_boolean.html" /> <link rel="prev" title="krb5_anonymous_principal - Build an anonymous principal." href="krb5_anonymous_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-anonymous-realm-return-an-anonymous-realm-data"> + <section id="krb5-anonymous-realm-return-an-anonymous-realm-data"> <h1>krb5_anonymous_realm - Return an anonymous realm data.<a class="headerlink" href="#krb5-anonymous-realm-return-an-anonymous-realm-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_anonymous_realm"> -const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> * <code class="descname">krb5_anonymous_realm</code><span class="sig-paren">(</span>void<em> None</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_anonymous_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_anonymous_realm"> +<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="sig-name descname"><span class="n"><span class="pre">krb5_anonymous_realm</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_anonymous_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>None</strong></td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>None</strong></p> +</dd> +</dl> <p>This function returns constant storage that must not be freed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="../macros/KRB5_ANONYMOUS_REALMSTR.html#KRB5_ANONYMOUS_REALMSTR" title="KRB5_ANONYMOUS_REALMSTR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_ANONYMOUS_REALMSTR</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>#KRB5_ANONYMOUS_REALMSTR</p> </div> +</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_anonymous_realm - Return an anonymous realm data.</a></li> @@ -132,6 +122,7 @@ const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" t <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +130,8 @@ const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" t <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_appdefault_boolean.html b/doc/html/appdev/refs/api/krb5_appdefault_boolean.html index 3b6b3d15c266..1d669d847ae6 100644 --- a/doc/html/appdev/refs/api/krb5_appdefault_boolean.html +++ b/doc/html/appdev/refs/api/krb5_appdefault_boolean.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_appdefault_boolean - Retrieve a boolean value from the appdefaults section of krb5.conf. — 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_appdefault_string - Retrieve a string value from the appdefaults section of krb5.conf." href="krb5_appdefault_string.html" /> <link rel="prev" title="krb5_anonymous_realm - Return an anonymous realm data." href="krb5_anonymous_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-appdefault-boolean-retrieve-a-boolean-value-from-the-appdefaults-section-of-krb5-conf"> + <section id="krb5-appdefault-boolean-retrieve-a-boolean-value-from-the-appdefaults-section-of-krb5-conf"> <h1>krb5_appdefault_boolean - Retrieve a boolean value from the appdefaults section of krb5.conf.<a class="headerlink" href="#krb5-appdefault-boolean-retrieve-a-boolean-value-from-the-appdefaults-section-of-krb5-conf" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_appdefault_boolean"> -void <code class="descname">krb5_appdefault_boolean</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 char *<em> appname</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> realm</em>, const char *<em> option</em>, int<em> default_value</em>, int *<em> ret_value</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_appdefault_boolean" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_appdefault_boolean"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_appdefault_boolean</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">appname</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">realm</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">option</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">default_value</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_appdefault_boolean" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>appname</strong> - Application name</p> <p><strong>[in]</strong> <strong>realm</strong> - Realm name</p> <p><strong>[in]</strong> <strong>option</strong> - Option to be checked</p> <p><strong>[in]</strong> <strong>default_value</strong> - Default value to return if no match is found</p> -<p class="last"><strong>[out]</strong> <strong>ret_value</strong> - Boolean value of <em>option</em></p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>ret_value</strong> - Boolean value of <em>option</em></p> +</dd> +</dl> <p>This function gets the application defaults for <em>option</em> based on the given <em>appname</em> and/or <em>realm</em> .</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_appdefault_string.html#c.krb5_appdefault_string" title="krb5_appdefault_string"><code class="xref c c-func docutils literal"><span class="pre">krb5_appdefault_string()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_appdefault_string()</p> </div> +</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_appdefault_boolean - Retrieve a boolean value from the appdefaults section of krb5.conf.</a></li> @@ -138,6 +127,7 @@ void <code class="descname">krb5_appdefault_boolean</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +135,8 @@ void <code class="descname">krb5_appdefault_boolean</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_appdefault_string.html b/doc/html/appdev/refs/api/krb5_appdefault_string.html index 505b7252d0d8..c3c9e8a9266f 100644 --- a/doc/html/appdev/refs/api/krb5_appdefault_string.html +++ b/doc/html/appdev/refs/api/krb5_appdefault_string.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_appdefault_string - Retrieve a string value from the appdefaults section of krb5.conf. — 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_auth_con_free - Free a krb5_auth_context structure." href="krb5_auth_con_free.html" /> <link rel="prev" title="krb5_appdefault_boolean - Retrieve a boolean value from the appdefaults section of krb5.conf." href="krb5_appdefault_boolean.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-appdefault-string-retrieve-a-string-value-from-the-appdefaults-section-of-krb5-conf"> + <section id="krb5-appdefault-string-retrieve-a-string-value-from-the-appdefaults-section-of-krb5-conf"> <h1>krb5_appdefault_string - Retrieve a string value from the appdefaults section of krb5.conf.<a class="headerlink" href="#krb5-appdefault-string-retrieve-a-string-value-from-the-appdefaults-section-of-krb5-conf" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_appdefault_string"> -void <code class="descname">krb5_appdefault_string</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 char *<em> appname</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> realm</em>, const char *<em> option</em>, const char *<em> default_value</em>, char **<em> ret_value</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_appdefault_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_appdefault_string"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_appdefault_string</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">appname</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">realm</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">option</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">default_value</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_appdefault_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>appname</strong> - Application name</p> <p><strong>[in]</strong> <strong>realm</strong> - Realm name</p> <p><strong>[in]</strong> <strong>option</strong> - Option to be checked</p> <p><strong>[in]</strong> <strong>default_value</strong> - Default value to return if no match is found</p> -<p class="last"><strong>[out]</strong> <strong>ret_value</strong> - String value of <em>option</em></p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>ret_value</strong> - String value of <em>option</em></p> +</dd> +</dl> <p>This function gets the application defaults for <em>option</em> based on the given <em>appname</em> and/or <em>realm</em> .</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_appdefault_boolean.html#c.krb5_appdefault_boolean" title="krb5_appdefault_boolean"><code class="xref c c-func docutils literal"><span class="pre">krb5_appdefault_boolean()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_appdefault_boolean()</p> </div> +</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_appdefault_string - Retrieve a string value from the appdefaults section of krb5.conf.</a></li> @@ -138,6 +127,7 @@ void <code class="descname">krb5_appdefault_string</code><span class="sig-paren" <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +135,8 @@ void <code class="descname">krb5_appdefault_string</code><span class="sig-paren" <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_free.html b/doc/html/appdev/refs/api/krb5_auth_con_free.html index 379ceb801f66..b7aed11695aa 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_free.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_free.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_auth_con_free - Free a krb5_auth_context structure. — 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_auth_con_genaddrs - Generate auth context addresses from a connected socket." href="krb5_auth_con_genaddrs.html" /> <link rel="prev" title="krb5_appdefault_string - Retrieve a string value from the appdefaults section of krb5.conf." href="krb5_appdefault_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-free-free-a-krb5-auth-context-structure"> + <section id="krb5-auth-con-free-free-a-krb5-auth-context-structure"> <h1>krb5_auth_con_free - Free a krb5_auth_context structure.<a class="headerlink" href="#krb5-auth-con-free-free-a-krb5-auth-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_free"> -<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_auth_con_free</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_free"> +<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_auth_con_free</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>auth_context</strong> - Authentication context to be freed</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 (always)</li> +<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>auth_context</strong> - Authentication context to be freed</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function frees an auth context allocated by <a class="reference internal" href="krb5_auth_con_init.html#c.krb5_auth_con_init" title="krb5_auth_con_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_init()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>This function frees an auth context allocated by krb5_auth_con_init().</p> +</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_auth_con_free - Free a krb5_auth_context structure.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_genaddrs.html b/doc/html/appdev/refs/api/krb5_auth_con_genaddrs.html index a4bd28794daa..2d99915cf489 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_genaddrs.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_genaddrs.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_auth_con_genaddrs - Generate auth context addresses from a connected socket. — 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_auth_con_get_checksum_func - Get the checksum callback from an auth context." href="krb5_auth_con_get_checksum_func.html" /> <link rel="prev" title="krb5_auth_con_free - Free a krb5_auth_context structure." href="krb5_auth_con_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-genaddrs-generate-auth-context-addresses-from-a-connected-socket"> + <section id="krb5-auth-con-genaddrs-generate-auth-context-addresses-from-a-connected-socket"> <h1>krb5_auth_con_genaddrs - Generate auth context addresses from a connected socket.<a class="headerlink" href="#krb5-auth-con-genaddrs-generate-auth-context-addresses-from-a-connected-socket" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_genaddrs"> -<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_auth_con_genaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, int<em> infd</em>, int<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_genaddrs" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_genaddrs"> +<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_auth_con_genaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">infd</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_genaddrs" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>infd</strong> - Connected socket descriptor</p> -<p class="last"><strong>[in]</strong> <strong>flags</strong> - Flags</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>flags</strong> - Flags</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 sets the local and/or remote addresses in <em>auth_context</em> based on the local and remote endpoints of the socket <em>infd</em> . The following flags determine the operations performed:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR</span></code></a> Generate local address.</li> -<li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR</span></code></a> Generate remote address.</li> -<li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR</span></code></a> Generate local address and port.</li> -<li><a class="reference internal" href="../macros/KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR.html#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR" title="KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR</span></code></a> Generate remote address and port.</li> +<li><p>#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_ADDR Generate local address.</p></li> +<li><p>#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_ADDR Generate remote address.</p></li> +<li><p>#KRB5_AUTH_CONTEXT_GENERATE_LOCAL_FULL_ADDR Generate local address and port.</p></li> +<li><p>#KRB5_AUTH_CONTEXT_GENERATE_REMOTE_FULL_ADDR Generate remote address and port.</p></li> </ul> </div></blockquote> -</div> +</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_auth_con_genaddrs - Generate auth context addresses from a connected socket.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_get_checksum_func.html b/doc/html/appdev/refs/api/krb5_auth_con_get_checksum_func.html index da6706f09ba6..ed6064b3a9cb 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_get_checksum_func.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_get_checksum_func.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_auth_con_get_checksum_func - Get the checksum callback from an auth context. — 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_auth_con_getaddrs - Retrieve address fields from an auth context." href="krb5_auth_con_getaddrs.html" /> <link rel="prev" title="krb5_auth_con_genaddrs - Generate auth context addresses from a connected socket." href="krb5_auth_con_genaddrs.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-get-checksum-func-get-the-checksum-callback-from-an-auth-context"> + <section id="krb5-auth-con-get-checksum-func-get-the-checksum-callback-from-an-auth-context"> <h1>krb5_auth_con_get_checksum_func - Get the checksum callback from an auth context.<a class="headerlink" href="#krb5-auth-con-get-checksum-func-get-the-checksum-callback-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_get_checksum_func"> -<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_auth_con_get_checksum_func</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_mk_req_checksum_func.html#c.krb5_mk_req_checksum_func" title="krb5_mk_req_checksum_func">krb5_mk_req_checksum_func</a> *<em> func</em>, void **<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_get_checksum_func" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_get_checksum_func"> +<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_auth_con_get_checksum_func</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_mk_req_checksum_func.html#c.krb5_mk_req_checksum_func" title="krb5_mk_req_checksum_func"><span class="n"><span class="pre">krb5_mk_req_checksum_func</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">func</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_get_checksum_func" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[out]</strong> <strong>func</strong> - Checksum callback</p> -<p class="last"><strong>[out]</strong> <strong>data</strong> - Callback argument</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 (always)</li> +<p><strong>[out]</strong> <strong>data</strong> - Callback argument</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_auth_con_get_checksum_func - Get the checksum callback from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getaddrs.html b/doc/html/appdev/refs/api/krb5_auth_con_getaddrs.html index 309073fb012f..6815e293133b 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getaddrs.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getaddrs.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_auth_con_getaddrs - Retrieve address fields from an auth context. — 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_auth_con_getauthenticator - Retrieve the authenticator from an auth context." href="krb5_auth_con_getauthenticator.html" /> <link rel="prev" title="krb5_auth_con_get_checksum_func - Get the checksum callback from an auth context." href="krb5_auth_con_get_checksum_func.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getaddrs-retrieve-address-fields-from-an-auth-context"> + <section id="krb5-auth-con-getaddrs-retrieve-address-fields-from-an-auth-context"> <h1>krb5_auth_con_getaddrs - Retrieve address fields from an auth context.<a class="headerlink" href="#krb5-auth-con-getaddrs-retrieve-address-fields-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getaddrs"> -<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_auth_con_getaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> **<em> local_addr</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> **<em> remote_addr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getaddrs" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getaddrs"> +<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_auth_con_getaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">local_addr</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">remote_addr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getaddrs" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[out]</strong> <strong>local_addr</strong> - Local address (NULL if not needed)</p> -<p class="last"><strong>[out]</strong> <strong>remote_addr</strong> - Remote address (NULL if not needed)</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>remote_addr</strong> - Remote address (NULL if not needed)</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> -</div> +</dd> +</dl> +</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_auth_con_getaddrs - Retrieve address fields from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getauthenticator.html b/doc/html/appdev/refs/api/krb5_auth_con_getauthenticator.html index 03cc6fef969d..55c82200a0e8 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getauthenticator.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getauthenticator.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_auth_con_getauthenticator - Retrieve the authenticator from an auth context. — 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_auth_con_getflags - Retrieve flags from a krb5_auth_context structure." href="krb5_auth_con_getflags.html" /> <link rel="prev" title="krb5_auth_con_getaddrs - Retrieve address fields from an auth context." href="krb5_auth_con_getaddrs.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getauthenticator-retrieve-the-authenticator-from-an-auth-context"> + <section id="krb5-auth-con-getauthenticator-retrieve-the-authenticator-from-an-auth-context"> <h1>krb5_auth_con_getauthenticator - Retrieve the authenticator from an auth context.<a class="headerlink" href="#krb5-auth-con-getauthenticator-retrieve-the-authenticator-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getauthenticator"> -<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_auth_con_getauthenticator</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator">krb5_authenticator</a> **<em> authenticator</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getauthenticator" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getauthenticator"> +<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_auth_con_getauthenticator</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator"><span class="n"><span class="pre">krb5_authenticator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authenticator</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getauthenticator" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>authenticator</strong> - Authenticator</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>authenticator</strong> - Authenticator</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> -<p>Use <a class="reference internal" href="krb5_free_authenticator.html#c.krb5_free_authenticator" title="krb5_free_authenticator"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_authenticator()</span></code></a> to free <em>authenticator</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_authenticator() to free <em>authenticator</em> when it is no longer needed.</p> +</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_auth_con_getauthenticator - Retrieve the authenticator from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getflags.html b/doc/html/appdev/refs/api/krb5_auth_con_getflags.html index 73c5c375042b..45879ca48891 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getflags.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getflags.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_auth_con_getflags - Retrieve flags from a krb5_auth_context structure. — 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_auth_con_getkey - Retrieve the session key from an auth context as a keyblock." href="krb5_auth_con_getkey.html" /> <link rel="prev" title="krb5_auth_con_getauthenticator - Retrieve the authenticator from an auth context." href="krb5_auth_con_getauthenticator.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getflags-retrieve-flags-from-a-krb5-auth-context-structure"> + <section id="krb5-auth-con-getflags-retrieve-flags-from-a-krb5-auth-context-structure"> <h1>krb5_auth_con_getflags - Retrieve flags from a krb5_auth_context structure.<a class="headerlink" href="#krb5-auth-con-getflags-retrieve-flags-from-a-krb5-auth-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getflags"> -<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_auth_con_getflags</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getflags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getflags"> +<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_auth_con_getflags</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getflags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>flags</strong> - Flags bit mask</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 (always)</li> +<p><strong>[out]</strong> <strong>flags</strong> - Flags bit mask</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Valid values for <em>flags</em> are:</p> <blockquote> <div><ul class="simple"> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> Use timestamps</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></code></a> Save timestamps</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> Use sequence numbers</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> Save sequence numbers</li> +<li><p>#KRB5_AUTH_CONTEXT_DO_TIME Use timestamps</p></li> +<li><p>#KRB5_AUTH_CONTEXT_RET_TIME Save timestamps</p></li> +<li><p>#KRB5_AUTH_CONTEXT_DO_SEQUENCE Use sequence numbers</p></li> +<li><p>#KRB5_AUTH_CONTEXT_RET_SEQUENCE Save sequence numbers</p></li> </ul> </div></blockquote> -</div> +</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_auth_con_getflags - Retrieve flags from a krb5_auth_context structure.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getkey.html b/doc/html/appdev/refs/api/krb5_auth_con_getkey.html index b9fc66e5409d..0e3216b7f183 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getkey.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_auth_con_getkey - Retrieve the session key from an auth context as a 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> <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_auth_con_getkey_k - Retrieve the session key from an auth context." href="krb5_auth_con_getkey_k.html" /> <link rel="prev" title="krb5_auth_con_getflags - Retrieve flags from a krb5_auth_context structure." href="krb5_auth_con_getflags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getkey-retrieve-the-session-key-from-an-auth-context-as-a-keyblock"> + <section id="krb5-auth-con-getkey-retrieve-the-session-key-from-an-auth-context-as-a-keyblock"> <h1>krb5_auth_con_getkey - Retrieve the session key from an auth context as a keyblock.<a class="headerlink" href="#krb5-auth-con-getkey-retrieve-the-session-key-from-an-auth-context-as-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getkey"> -<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_auth_con_getkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getkey"> +<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_auth_con_getkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>keyblock</strong> - Session key</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>keyblock</strong> - Session key</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> -<p>This function creates a keyblock containing the session key from <em>auth_context</em> . Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>keyblock</em> when it is no longer needed</p> -</div> +</dd> +</dl> +<p>This function creates a keyblock containing the session key from <em>auth_context</em> . Use krb5_free_keyblock() to free <em>keyblock</em> when it is no longer needed</p> +</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_auth_con_getkey - Retrieve the session key from an auth context as a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getkey_k.html b/doc/html/appdev/refs/api/krb5_auth_con_getkey_k.html index 74264ab91503..9a00fefe2d82 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getkey_k.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getkey_k.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_auth_con_getkey_k - Retrieve the session key from an auth context. — 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_auth_con_getlocalseqnumber - Retrieve the local sequence number from an auth context." href="krb5_auth_con_getlocalseqnumber.html" /> <link rel="prev" title="krb5_auth_con_getkey - Retrieve the session key from an auth context as a keyblock." href="krb5_auth_con_getkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getkey-k-retrieve-the-session-key-from-an-auth-context"> + <section id="krb5-auth-con-getkey-k-retrieve-the-session-key-from-an-auth-context"> <h1>krb5_auth_con_getkey_k - Retrieve the session key from an auth context.<a class="headerlink" href="#krb5-auth-con-getkey-k-retrieve-the-session-key-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getkey_k"> -<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_auth_con_getkey_k</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getkey_k" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getkey_k"> +<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_auth_con_getkey_k</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getkey_k" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Session key</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 (always)</li> +<p><strong>[out]</strong> <strong>key</strong> - Session key</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function sets <em>key</em> to the session key from <em>auth_context</em> . Use <a class="reference internal" href="krb5_k_free_key.html#c.krb5_k_free_key" title="krb5_k_free_key"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_free_key()</span></code></a> to release <em>key</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function sets <em>key</em> to the session key from <em>auth_context</em> . Use krb5_k_free_key() to release <em>key</em> when it is no longer needed.</p> +</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_auth_con_getkey_k - Retrieve the session key from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getlocalseqnumber.html b/doc/html/appdev/refs/api/krb5_auth_con_getlocalseqnumber.html index 2508673e5819..441299c57a60 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getlocalseqnumber.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getlocalseqnumber.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_auth_con_getlocalseqnumber - Retrieve the local sequence number from an auth context. — 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_auth_con_getrcache - Retrieve the replay cache from an auth context." href="krb5_auth_con_getrcache.html" /> <link rel="prev" title="krb5_auth_con_getkey_k - Retrieve the session key from an auth context." href="krb5_auth_con_getkey_k.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getlocalseqnumber-retrieve-the-local-sequence-number-from-an-auth-context"> + <section id="krb5-auth-con-getlocalseqnumber-retrieve-the-local-sequence-number-from-an-auth-context"> <h1>krb5_auth_con_getlocalseqnumber - Retrieve the local sequence number from an auth context.<a class="headerlink" href="#krb5-auth-con-getlocalseqnumber-retrieve-the-local-sequence-number-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getlocalseqnumber"> -<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_auth_con_getlocalseqnumber</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> seqnumber</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getlocalseqnumber" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getlocalseqnumber"> +<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_auth_con_getlocalseqnumber</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">seqnumber</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getlocalseqnumber" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>seqnumber</strong> - Local sequence number</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>seqnumber</strong> - Local sequence number</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> -<p>Retrieve the local sequence number from <em>auth_context</em> and return it in <em>seqnumber</em> . 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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> flag must be set in <em>auth_context</em> for this function to be useful.</p> -</div> +</dd> +</dl> +<p>Retrieve the local sequence number from <em>auth_context</em> and return it in <em>seqnumber</em> . The #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag must be set in <em>auth_context</em> for this function to be useful.</p> +</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_auth_con_getlocalseqnumber - Retrieve the local sequence number from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getlocalsubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_getlocalsubkey.html index b5445d8c6bcc..dc0b5fe7e394 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getlocalsubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getlocalsubkey.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_auth_con_getlocalsubkey — 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_auth_con_getremotesubkey" href="krb5_auth_con_getremotesubkey.html" /> <link rel="prev" title="krb5_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials." href="krb5_524_convert_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getlocalsubkey"> + <section id="krb5-auth-con-getlocalsubkey"> <h1>krb5_auth_con_getlocalsubkey<a class="headerlink" href="#krb5-auth-con-getlocalsubkey" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getlocalsubkey"> -<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_auth_con_getlocalsubkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getlocalsubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getlocalsubkey"> +<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_auth_con_getlocalsubkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getlocalsubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>auth_context</strong></p> -<p class="last"><strong>keyblock</strong></p> -</td> -</tr> -</tbody> -</table> -<p>DEPRECATED Replaced by krb5_auth_con_getsendsubkey() .</p> -</div> +<p><strong>keyblock</strong></p> +</dd> +</dl> +<p>DEPRECATED Replaced by krb5_auth_con_getsendsubkey().</p> +</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_auth_con_getlocalsubkey</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getrcache.html b/doc/html/appdev/refs/api/krb5_auth_con_getrcache.html index b4aed27e760d..0d432a5ef6e9 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getrcache.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getrcache.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_auth_con_getrcache - Retrieve the replay cache from an auth context. — 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_auth_con_getrecvsubkey - Retrieve the receiving subkey from an auth context as a keyblock." href="krb5_auth_con_getrecvsubkey.html" /> <link rel="prev" title="krb5_auth_con_getlocalseqnumber - Retrieve the local sequence number from an auth context." href="krb5_auth_con_getlocalseqnumber.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getrcache-retrieve-the-replay-cache-from-an-auth-context"> + <section id="krb5-auth-con-getrcache-retrieve-the-replay-cache-from-an-auth-context"> <h1>krb5_auth_con_getrcache - Retrieve the replay cache from an auth context.<a class="headerlink" href="#krb5-auth-con-getrcache-retrieve-the-replay-cache-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getrcache"> -<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_auth_con_getrcache</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache">krb5_rcache</a> *<em> rcache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrcache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getrcache"> +<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_auth_con_getrcache</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache"><span class="n"><span class="pre">krb5_rcache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rcache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrcache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>rcache</strong> - Replay cache handle</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 (always)</li> +<p><strong>[out]</strong> <strong>rcache</strong> - Replay cache handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function fetches the replay cache from <em>auth_context</em> . The caller should not close <em>rcache</em> .</p> -</div> +</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_auth_con_getrcache - Retrieve the replay cache from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey.html index bec557a49394..38304c09974c 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey.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_auth_con_getrecvsubkey - Retrieve the receiving subkey from an auth context as a 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> <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_auth_con_getrecvsubkey_k - Retrieve the receiving subkey from an auth context as a keyblock." href="krb5_auth_con_getrecvsubkey_k.html" /> <link rel="prev" title="krb5_auth_con_getrcache - Retrieve the replay cache from an auth context." href="krb5_auth_con_getrcache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getrecvsubkey-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock"> + <section id="krb5-auth-con-getrecvsubkey-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock"> <h1>krb5_auth_con_getrecvsubkey - Retrieve the receiving subkey from an auth context as a keyblock.<a class="headerlink" href="#krb5-auth-con-getrecvsubkey-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getrecvsubkey"> -<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_auth_con_getrecvsubkey</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrecvsubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getrecvsubkey"> +<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_auth_con_getrecvsubkey</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrecvsubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>keyblock</strong> - Receiving subkey</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>keyblock</strong> - Receiving subkey</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> -<p>This function creates a keyblock containing the receiving subkey from <em>auth_context</em> . Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>keyblock</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a keyblock containing the receiving subkey from <em>auth_context</em> . Use krb5_free_keyblock() to free <em>keyblock</em> when it is no longer needed.</p> +</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_auth_con_getrecvsubkey - Retrieve the receiving subkey from an auth context as a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey_k.html b/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey_k.html index 03e94069e6c5..112ea8c6a75c 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey_k.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getrecvsubkey_k.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_auth_con_getrecvsubkey_k - Retrieve the receiving subkey from an auth context as a 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> <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_auth_con_getremoteseqnumber - Retrieve the remote sequence number from an auth context." href="krb5_auth_con_getremoteseqnumber.html" /> <link rel="prev" title="krb5_auth_con_getrecvsubkey - Retrieve the receiving subkey from an auth context as a keyblock." href="krb5_auth_con_getrecvsubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getrecvsubkey-k-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock"> + <section id="krb5-auth-con-getrecvsubkey-k-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock"> <h1>krb5_auth_con_getrecvsubkey_k - Retrieve the receiving subkey from an auth context as a keyblock.<a class="headerlink" href="#krb5-auth-con-getrecvsubkey-k-retrieve-the-receiving-subkey-from-an-auth-context-as-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getrecvsubkey_k"> -<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_auth_con_getrecvsubkey_k</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrecvsubkey_k" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getrecvsubkey_k"> +<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_auth_con_getrecvsubkey_k</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getrecvsubkey_k" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Receiving subkey</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>key</strong> - Receiving subkey</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> -<p>This function sets <em>key</em> to the receiving subkey from <em>auth_context</em> . Use <a class="reference internal" href="krb5_k_free_key.html#c.krb5_k_free_key" title="krb5_k_free_key"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_free_key()</span></code></a> to release <em>key</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function sets <em>key</em> to the receiving subkey from <em>auth_context</em> . Use krb5_k_free_key() to release <em>key</em> when it is no longer needed.</p> +</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_auth_con_getrecvsubkey_k - Retrieve the receiving subkey from an auth context as a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getremoteseqnumber.html b/doc/html/appdev/refs/api/krb5_auth_con_getremoteseqnumber.html index e2eeabf71016..60c5a7d0f06a 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getremoteseqnumber.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getremoteseqnumber.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_auth_con_getremoteseqnumber - Retrieve the remote sequence number from an auth context. — 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_auth_con_getsendsubkey - Retrieve the send subkey from an auth context as a keyblock." href="krb5_auth_con_getsendsubkey.html" /> <link rel="prev" title="krb5_auth_con_getrecvsubkey_k - Retrieve the receiving subkey from an auth context as a keyblock." href="krb5_auth_con_getrecvsubkey_k.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getremoteseqnumber-retrieve-the-remote-sequence-number-from-an-auth-context"> + <section id="krb5-auth-con-getremoteseqnumber-retrieve-the-remote-sequence-number-from-an-auth-context"> <h1>krb5_auth_con_getremoteseqnumber - Retrieve the remote sequence number from an auth context.<a class="headerlink" href="#krb5-auth-con-getremoteseqnumber-retrieve-the-remote-sequence-number-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getremoteseqnumber"> -<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_auth_con_getremoteseqnumber</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> seqnumber</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getremoteseqnumber" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getremoteseqnumber"> +<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_auth_con_getremoteseqnumber</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">seqnumber</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getremoteseqnumber" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>seqnumber</strong> - Remote sequence number</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>seqnumber</strong> - Remote sequence number</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> -<p>Retrieve the remote sequence number from <em>auth_context</em> and return it in <em>seqnumber</em> . 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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> flag must be set in <em>auth_context</em> for this function to be useful.</p> -</div> +</dd> +</dl> +<p>Retrieve the remote sequence number from <em>auth_context</em> and return it in <em>seqnumber</em> . The #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag must be set in <em>auth_context</em> for this function to be useful.</p> +</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_auth_con_getremoteseqnumber - Retrieve the remote sequence number from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getremotesubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_getremotesubkey.html index 33d689be9763..76c1d128250e 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getremotesubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getremotesubkey.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_auth_con_getremotesubkey — 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_auth_con_initivector - Cause an auth context to use cipher state." href="krb5_auth_con_initivector.html" /> <link rel="prev" title="krb5_auth_con_getlocalsubkey" href="krb5_auth_con_getlocalsubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getremotesubkey"> + <section id="krb5-auth-con-getremotesubkey"> <h1>krb5_auth_con_getremotesubkey<a class="headerlink" href="#krb5-auth-con-getremotesubkey" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getremotesubkey"> -<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_auth_con_getremotesubkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getremotesubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getremotesubkey"> +<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_auth_con_getremotesubkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getremotesubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>auth_context</strong></p> -<p class="last"><strong>keyblock</strong></p> -</td> -</tr> -</tbody> -</table> -<p>DEPRECATED Replaced by krb5_auth_con_getrecvsubkey() .</p> -</div> +<p><strong>keyblock</strong></p> +</dd> +</dl> +<p>DEPRECATED Replaced by krb5_auth_con_getrecvsubkey().</p> +</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_auth_con_getremotesubkey</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey.html index f8cc85abae64..efeeb3bed979 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey.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_auth_con_getsendsubkey - Retrieve the send subkey from an auth context as a 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> <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_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context." href="krb5_auth_con_getsendsubkey_k.html" /> <link rel="prev" title="krb5_auth_con_getremoteseqnumber - Retrieve the remote sequence number from an auth context." href="krb5_auth_con_getremoteseqnumber.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getsendsubkey-retrieve-the-send-subkey-from-an-auth-context-as-a-keyblock"> + <section id="krb5-auth-con-getsendsubkey-retrieve-the-send-subkey-from-an-auth-context-as-a-keyblock"> <h1>krb5_auth_con_getsendsubkey - Retrieve the send subkey from an auth context as a keyblock.<a class="headerlink" href="#krb5-auth-con-getsendsubkey-retrieve-the-send-subkey-from-an-auth-context-as-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getsendsubkey"> -<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_auth_con_getsendsubkey</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getsendsubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getsendsubkey"> +<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_auth_con_getsendsubkey</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getsendsubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>keyblock</strong> - Send subkey</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>keyblock</strong> - Send subkey</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> -<p>This function creates a keyblock containing the send subkey from <em>auth_context</em> . Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>keyblock</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a keyblock containing the send subkey from <em>auth_context</em> . Use krb5_free_keyblock() to free <em>keyblock</em> when it is no longer needed.</p> +</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_auth_con_getsendsubkey - Retrieve the send subkey from an auth context as a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey_k.html b/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey_k.html index 363e8c4e73f3..ddbc602b4609 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey_k.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_getsendsubkey_k.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_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context. — 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_auth_con_init - Create and initialize an authentication context." href="krb5_auth_con_init.html" /> <link rel="prev" title="krb5_auth_con_getsendsubkey - Retrieve the send subkey from an auth context as a keyblock." href="krb5_auth_con_getsendsubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-getsendsubkey-k-retrieve-the-send-subkey-from-an-auth-context"> + <section id="krb5-auth-con-getsendsubkey-k-retrieve-the-send-subkey-from-an-auth-context"> <h1>krb5_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context.<a class="headerlink" href="#krb5-auth-con-getsendsubkey-k-retrieve-the-send-subkey-from-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_getsendsubkey_k"> -<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_auth_con_getsendsubkey_k</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getsendsubkey_k" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_getsendsubkey_k"> +<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_auth_con_getsendsubkey_k</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_getsendsubkey_k" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Send subkey</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>key</strong> - Send subkey</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> -<p>This function sets <em>key</em> to the send subkey from <em>auth_context</em> . Use <a class="reference internal" href="krb5_k_free_key.html#c.krb5_k_free_key" title="krb5_k_free_key"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_free_key()</span></code></a> to release <em>key</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function sets <em>key</em> to the send subkey from <em>auth_context</em> . Use krb5_k_free_key() to release <em>key</em> when it is no longer needed.</p> +</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_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_init.html b/doc/html/appdev/refs/api/krb5_auth_con_init.html index 801a3c4011b1..69cffb3e7e8e 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_init.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_init.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_auth_con_init - Create and initialize an authentication context. — 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_auth_con_set_checksum_func - Set a checksum callback in an auth context." href="krb5_auth_con_set_checksum_func.html" /> <link rel="prev" title="krb5_auth_con_getsendsubkey_k - Retrieve the send subkey from an auth context." href="krb5_auth_con_getsendsubkey_k.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-init-create-and-initialize-an-authentication-context"> + <section id="krb5-auth-con-init-create-and-initialize-an-authentication-context"> <h1>krb5_auth_con_init - Create and initialize an authentication context.<a class="headerlink" href="#krb5-auth-con-init-create-and-initialize-an-authentication-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_init"> -<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_auth_con_init</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_init"> +<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_auth_con_init</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>auth_context</strong> - Authentication context</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> +<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>[out]</strong> <strong>auth_context</strong> - Authentication context</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 creates an authentication context to hold configuration and state relevant to krb5 functions for authenticating principals and protecting messages once authentication has occurred.</p> -<p>By default, flags for the context are set to enable the use of the replay cache ( <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> ), but not sequence numbers. Use <a class="reference internal" href="krb5_auth_con_setflags.html#c.krb5_auth_con_setflags" title="krb5_auth_con_setflags"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_setflags()</span></code></a> to change the flags.</p> -<p>The allocated <em>auth_context</em> must be freed with <a class="reference internal" href="krb5_auth_con_free.html#c.krb5_auth_con_free" title="krb5_auth_con_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_free()</span></code></a> when it is no longer needed.</p> -</div> +<p>By default, flags for the context are set to enable the use of the replay cache (#KRB5_AUTH_CONTEXT_DO_TIME), but not sequence numbers. Use krb5_auth_con_setflags() to change the flags.</p> +<p>The allocated <em>auth_context</em> must be freed with krb5_auth_con_free() when it is no longer needed.</p> +</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_auth_con_init - Create and initialize an authentication context.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_initivector.html b/doc/html/appdev/refs/api/krb5_auth_con_initivector.html index 1f49679f9adc..03000f72805c 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_initivector.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_initivector.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_auth_con_initivector - Cause an auth context to use cipher state. — 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_va" href="krb5_build_principal_va.html" /> <link rel="prev" title="krb5_auth_con_getremotesubkey" href="krb5_auth_con_getremotesubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-initivector-cause-an-auth-context-to-use-cipher-state"> + <section id="krb5-auth-con-initivector-cause-an-auth-context-to-use-cipher-state"> <h1>krb5_auth_con_initivector - Cause an auth context to use cipher state.<a class="headerlink" href="#krb5-auth-con-initivector-cause-an-auth-context-to-use-cipher-state" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_initivector"> -<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_auth_con_initivector</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_initivector" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_initivector"> +<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_auth_con_initivector</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_initivector" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>auth_context</strong> - Authentication context</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> +<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>auth_context</strong> - Authentication context</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> -<p>Prepare <em>auth_context</em> to use cipher state when <a class="reference internal" href="krb5_mk_priv.html#c.krb5_mk_priv" title="krb5_mk_priv"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_priv()</span></code></a> or <a class="reference internal" href="krb5_rd_priv.html#c.krb5_rd_priv" title="krb5_rd_priv"><code class="xref c c-func docutils literal"><span class="pre">krb5_rd_priv()</span></code></a> encrypt or decrypt data.</p> -</div> +</dd> +</dl> +<p>Prepare <em>auth_context</em> to use cipher state when krb5_mk_priv() or krb5_rd_priv() encrypt or decrypt data.</p> +</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_auth_con_initivector - Cause an auth context to use cipher state.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_set_checksum_func.html b/doc/html/appdev/refs/api/krb5_auth_con_set_checksum_func.html index a7e4e14c92e4..f6bdfdbe9613 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_set_checksum_func.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_set_checksum_func.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_auth_con_set_checksum_func - Set a checksum callback in an auth context. — 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_auth_con_set_req_cksumtype - Set checksum type in an an auth context." href="krb5_auth_con_set_req_cksumtype.html" /> <link rel="prev" title="krb5_auth_con_init - Create and initialize an authentication context." href="krb5_auth_con_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-set-checksum-func-set-a-checksum-callback-in-an-auth-context"> + <section id="krb5-auth-con-set-checksum-func-set-a-checksum-callback-in-an-auth-context"> <h1>krb5_auth_con_set_checksum_func - Set a checksum callback in an auth context.<a class="headerlink" href="#krb5-auth-con-set-checksum-func-set-a-checksum-callback-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_set_checksum_func"> -<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_auth_con_set_checksum_func</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_mk_req_checksum_func.html#c.krb5_mk_req_checksum_func" title="krb5_mk_req_checksum_func">krb5_mk_req_checksum_func</a><em> func</em>, void *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_set_checksum_func" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_set_checksum_func"> +<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_auth_con_set_checksum_func</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_mk_req_checksum_func.html#c.krb5_mk_req_checksum_func" title="krb5_mk_req_checksum_func"><span class="n"><span class="pre">krb5_mk_req_checksum_func</span></span></a><span class="w"> </span><span class="n"><span class="pre">func</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_set_checksum_func" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>func</strong> - Checksum callback</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Callback argument</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 (always)</li> +<p><strong>[in]</strong> <strong>data</strong> - Callback argument</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Set a callback to obtain checksum data in <a class="reference internal" href="krb5_mk_req.html#c.krb5_mk_req" title="krb5_mk_req"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></code></a> . The callback will be invoked after the subkey and local sequence number are stored in <em>auth_context</em> .</p> -</div> +</dd> +</dl> +<p>Set a callback to obtain checksum data in krb5_mk_req(). The callback will be invoked after the subkey and local sequence number are stored in <em>auth_context</em> .</p> +</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_auth_con_set_checksum_func - Set a checksum callback in an auth context.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_set_req_cksumtype.html b/doc/html/appdev/refs/api/krb5_auth_con_set_req_cksumtype.html index 8e2e1c94b6b1..267309de1bb4 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_set_req_cksumtype.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_set_req_cksumtype.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_auth_con_set_req_cksumtype - Set checksum type in an an auth context. — 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_auth_con_setaddrs - Set the local and remote addresses in an auth context." href="krb5_auth_con_setaddrs.html" /> <link rel="prev" title="krb5_auth_con_set_checksum_func - Set a checksum callback in an auth context." href="krb5_auth_con_set_checksum_func.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-set-req-cksumtype-set-checksum-type-in-an-an-auth-context"> + <section id="krb5-auth-con-set-req-cksumtype-set-checksum-type-in-an-an-auth-context"> <h1>krb5_auth_con_set_req_cksumtype - Set checksum type in an an auth context.<a class="headerlink" href="#krb5-auth-con-set-req-cksumtype-set-checksum-type-in-an-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_set_req_cksumtype"> -<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_auth_con_set_req_cksumtype</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_set_req_cksumtype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_set_req_cksumtype"> +<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_auth_con_set_req_cksumtype</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_set_req_cksumtype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>cksumtype</strong> - Checksum type</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>cksumtype</strong> - Checksum type</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> -<p>This function sets the checksum type in <em>auth_context</em> to be used by <a class="reference internal" href="krb5_mk_req.html#c.krb5_mk_req" title="krb5_mk_req"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></code></a> for the authenticator checksum.</p> -</div> +</dd> +</dl> +<p>This function sets the checksum type in <em>auth_context</em> to be used by krb5_mk_req() for the authenticator checksum.</p> +</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_auth_con_set_req_cksumtype - Set checksum type in an an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setaddrs.html b/doc/html/appdev/refs/api/krb5_auth_con_setaddrs.html index 083eed08336e..bc62882c54d9 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setaddrs.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setaddrs.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_auth_con_setaddrs - Set the local and remote addresses in an auth context. — 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_auth_con_setflags - Set a flags field in a krb5_auth_context structure." href="krb5_auth_con_setflags.html" /> <link rel="prev" title="krb5_auth_con_set_req_cksumtype - Set checksum type in an an auth context." href="krb5_auth_con_set_req_cksumtype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setaddrs-set-the-local-and-remote-addresses-in-an-auth-context"> + <section id="krb5-auth-con-setaddrs-set-the-local-and-remote-addresses-in-an-auth-context"> <h1>krb5_auth_con_setaddrs - Set the local and remote addresses in an auth context.<a class="headerlink" href="#krb5-auth-con-setaddrs-set-the-local-and-remote-addresses-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setaddrs"> -<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_auth_con_setaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> local_addr</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> remote_addr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setaddrs" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setaddrs"> +<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_auth_con_setaddrs</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">local_addr</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">remote_addr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setaddrs" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>local_addr</strong> - Local address</p> -<p class="last"><strong>[in]</strong> <strong>remote_addr</strong> - Remote address</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>remote_addr</strong> - Remote address</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 releases the storage assigned to the contents of the local and remote addresses of <em>auth_context</em> and then sets them to <em>local_addr</em> and <em>remote_addr</em> respectively.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_auth_con_genaddrs.html#c.krb5_auth_con_genaddrs" title="krb5_auth_con_genaddrs"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_genaddrs()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_auth_con_genaddrs()</p> </div> +</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_auth_con_setaddrs - Set the local and remote addresses in an auth context.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setflags.html b/doc/html/appdev/refs/api/krb5_auth_con_setflags.html index b20cfb6e5aa0..98f5ed54259d 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setflags.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setflags.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_auth_con_setflags - Set a flags field in a krb5_auth_context structure. — 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_auth_con_setports - Set local and remote port fields in an auth context." href="krb5_auth_con_setports.html" /> <link rel="prev" title="krb5_auth_con_setaddrs - Set the local and remote addresses in an auth context." href="krb5_auth_con_setaddrs.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setflags-set-a-flags-field-in-a-krb5-auth-context-structure"> + <section id="krb5-auth-con-setflags-set-a-flags-field-in-a-krb5-auth-context-structure"> <h1>krb5_auth_con_setflags - Set a flags field in a krb5_auth_context structure.<a class="headerlink" href="#krb5-auth-con-setflags-set-a-flags-field-in-a-krb5-auth-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setflags"> -<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_auth_con_setflags</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setflags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setflags"> +<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_auth_con_setflags</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setflags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>flags</strong> - Flags bit mask</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 (always)</li> +<p><strong>[in]</strong> <strong>flags</strong> - Flags bit mask</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Valid values for <em>flags</em> are:</p> <blockquote> <div><ul class="simple"> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> Use timestamps</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></code></a> Save timestamps</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> Use sequence numbers</li> -<li><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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> Save sequence numbers</li> +<li><p>#KRB5_AUTH_CONTEXT_DO_TIME Use timestamps</p></li> +<li><p>#KRB5_AUTH_CONTEXT_RET_TIME Save timestamps</p></li> +<li><p>#KRB5_AUTH_CONTEXT_DO_SEQUENCE Use sequence numbers</p></li> +<li><p>#KRB5_AUTH_CONTEXT_RET_SEQUENCE Save sequence numbers</p></li> </ul> </div></blockquote> -</div> +</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_auth_con_setflags - Set a flags field in a krb5_auth_context structure.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setports.html b/doc/html/appdev/refs/api/krb5_auth_con_setports.html index 6a2fc6c89a5a..6a28f81222a4 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setports.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setports.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_auth_con_setports - Set local and remote port fields in an auth context. — 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_auth_con_setrcache - Set the replay cache in an auth context." href="krb5_auth_con_setrcache.html" /> <link rel="prev" title="krb5_auth_con_setflags - Set a flags field in a krb5_auth_context structure." href="krb5_auth_con_setflags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setports-set-local-and-remote-port-fields-in-an-auth-context"> + <section id="krb5-auth-con-setports-set-local-and-remote-port-fields-in-an-auth-context"> <h1>krb5_auth_con_setports - Set local and remote port fields in an auth context.<a class="headerlink" href="#krb5-auth-con-setports-set-local-and-remote-port-fields-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setports"> -<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_auth_con_setports</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> local_port</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *<em> remote_port</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setports" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setports"> +<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_auth_con_setports</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">local_port</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">remote_port</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setports" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>local_port</strong> - Local port</p> -<p class="last"><strong>[in]</strong> <strong>remote_port</strong> - Remote port</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>remote_port</strong> - Remote port</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 releases the storage assigned to the contents of the local and remote ports of <em>auth_context</em> and then sets them to <em>local_port</em> and <em>remote_port</em> respectively.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_auth_con_genaddrs.html#c.krb5_auth_con_genaddrs" title="krb5_auth_con_genaddrs"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_genaddrs()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_auth_con_genaddrs()</p> </div> +</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_auth_con_setports - Set local and remote port fields in an auth context.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setrcache.html b/doc/html/appdev/refs/api/krb5_auth_con_setrcache.html index 1350d2a18143..a0654219b1ff 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setrcache.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setrcache.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_auth_con_setrcache - Set the replay cache in an auth context. — 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_auth_con_setrecvsubkey - Set the receiving subkey in an auth context with a keyblock." href="krb5_auth_con_setrecvsubkey.html" /> <link rel="prev" title="krb5_auth_con_setports - Set local and remote port fields in an auth context." href="krb5_auth_con_setports.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setrcache-set-the-replay-cache-in-an-auth-context"> + <section id="krb5-auth-con-setrcache-set-the-replay-cache-in-an-auth-context"> <h1>krb5_auth_con_setrcache - Set the replay cache in an auth context.<a class="headerlink" href="#krb5-auth-con-setrcache-set-the-replay-cache-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setrcache"> -<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_auth_con_setrcache</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache">krb5_rcache</a><em> rcache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrcache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setrcache"> +<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_auth_con_setrcache</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache"><span class="n"><span class="pre">krb5_rcache</span></span></a><span class="w"> </span><span class="n"><span class="pre">rcache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrcache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>rcache</strong> - Replay cache haddle</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>rcache</strong> - Replay cache haddle</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 sets the replay cache in <em>auth_context</em> to <em>rcache</em> . <em>rcache</em> will be closed when <em>auth_context</em> is freed, so the caller should relinquish that responsibility.</p> -</div> +</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_auth_con_setrcache - Set the replay cache in an auth context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey.html index 077400d1ee44..9236396b3de6 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey.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_auth_con_setrecvsubkey - Set the receiving subkey in an auth context with a 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> <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_auth_con_setrecvsubkey_k - Set the receiving subkey in an auth context." href="krb5_auth_con_setrecvsubkey_k.html" /> <link rel="prev" title="krb5_auth_con_setrcache - Set the replay cache in an auth context." href="krb5_auth_con_setrcache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setrecvsubkey-set-the-receiving-subkey-in-an-auth-context-with-a-keyblock"> + <section id="krb5-auth-con-setrecvsubkey-set-the-receiving-subkey-in-an-auth-context-with-a-keyblock"> <h1>krb5_auth_con_setrecvsubkey - Set the receiving subkey in an auth context with a keyblock.<a class="headerlink" href="#krb5-auth-con-setrecvsubkey-set-the-receiving-subkey-in-an-auth-context-with-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setrecvsubkey"> -<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_auth_con_setrecvsubkey</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrecvsubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setrecvsubkey"> +<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_auth_con_setrecvsubkey</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrecvsubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>keyblock</strong> - Receiving subkey</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>keyblock</strong> - Receiving subkey</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 sets the receiving subkey in <em>ac</em> to a copy of <em>keyblock</em> .</p> -</div> +</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_auth_con_setrecvsubkey - Set the receiving subkey in an auth context with a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey_k.html b/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey_k.html index 6330ff1dfa94..1f59b6601887 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey_k.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setrecvsubkey_k.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_auth_con_setrecvsubkey_k - Set the receiving subkey in an auth context. — 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_auth_con_setsendsubkey - Set the send subkey in an auth context with a keyblock." href="krb5_auth_con_setsendsubkey.html" /> <link rel="prev" title="krb5_auth_con_setrecvsubkey - Set the receiving subkey in an auth context with a keyblock." href="krb5_auth_con_setrecvsubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setrecvsubkey-k-set-the-receiving-subkey-in-an-auth-context"> + <section id="krb5-auth-con-setrecvsubkey-k-set-the-receiving-subkey-in-an-auth-context"> <h1>krb5_auth_con_setrecvsubkey_k - Set the receiving subkey in an auth context.<a class="headerlink" href="#krb5-auth-con-setrecvsubkey-k-set-the-receiving-subkey-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setrecvsubkey_k"> -<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_auth_con_setrecvsubkey_k</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrecvsubkey_k" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setrecvsubkey_k"> +<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_auth_con_setrecvsubkey_k</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setrecvsubkey_k" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>key</strong> - Receiving subkey</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>key</strong> - Receiving subkey</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 sets the receiving subkey in <em>ac</em> to <em>key</em> , incrementing its reference count.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_auth_con_setrecvsubkey_k - Set the receiving subkey in an auth context.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey.html b/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey.html index 1b7003455787..6c2fe8e3ba73 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey.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_auth_con_setsendsubkey - Set the send subkey in an auth context with a 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> <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_auth_con_setsendsubkey_k - Set the send subkey in an auth context." href="krb5_auth_con_setsendsubkey_k.html" /> <link rel="prev" title="krb5_auth_con_setrecvsubkey_k - Set the receiving subkey in an auth context." href="krb5_auth_con_setrecvsubkey_k.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setsendsubkey-set-the-send-subkey-in-an-auth-context-with-a-keyblock"> + <section id="krb5-auth-con-setsendsubkey-set-the-send-subkey-in-an-auth-context-with-a-keyblock"> <h1>krb5_auth_con_setsendsubkey - Set the send subkey in an auth context with a keyblock.<a class="headerlink" href="#krb5-auth-con-setsendsubkey-set-the-send-subkey-in-an-auth-context-with-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setsendsubkey"> -<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_auth_con_setsendsubkey</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setsendsubkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setsendsubkey"> +<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_auth_con_setsendsubkey</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setsendsubkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>keyblock</strong> - Send subkey</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>keyblock</strong> - Send subkey</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 sets the send subkey in <em>ac</em> to a copy of <em>keyblock</em> .</p> -</div> +</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_auth_con_setsendsubkey - Set the send subkey in an auth context with a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey_k.html b/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey_k.html index f3da6304e5c9..4047613f6016 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey_k.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setsendsubkey_k.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_auth_con_setsendsubkey_k - Set the send subkey in an auth context. — 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_auth_con_setuseruserkey - Set the session key in an auth context." href="krb5_auth_con_setuseruserkey.html" /> <link rel="prev" title="krb5_auth_con_setsendsubkey - Set the send subkey in an auth context with a keyblock." href="krb5_auth_con_setsendsubkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setsendsubkey-k-set-the-send-subkey-in-an-auth-context"> + <section id="krb5-auth-con-setsendsubkey-k-set-the-send-subkey-in-an-auth-context"> <h1>krb5_auth_con_setsendsubkey_k - Set the send subkey in an auth context.<a class="headerlink" href="#krb5-auth-con-setsendsubkey-k-set-the-send-subkey-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setsendsubkey_k"> -<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_auth_con_setsendsubkey_k</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> ctx</em>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> ac</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setsendsubkey_k" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setsendsubkey_k"> +<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_auth_con_setsendsubkey_k</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ac</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setsendsubkey_k" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>ac</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Send subkey</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>key</strong> - Send subkey</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 sets the send subkey in <em>ac</em> to <em>key</em> , incrementing its reference count.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_auth_con_setsendsubkey_k - Set the send subkey in an auth context.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_auth_con_setuseruserkey.html b/doc/html/appdev/refs/api/krb5_auth_con_setuseruserkey.html index 1b9a41ff0ffd..a7929a2a4cb1 100644 --- a/doc/html/appdev/refs/api/krb5_auth_con_setuseruserkey.html +++ b/doc/html/appdev/refs/api/krb5_auth_con_setuseruserkey.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_auth_con_setuseruserkey - Set the session key in an auth context. — 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_cc_cache_match - Find a credential cache with a specified client principal." href="krb5_cc_cache_match.html" /> <link rel="prev" title="krb5_auth_con_setsendsubkey_k - Set the send subkey in an auth context." href="krb5_auth_con_setsendsubkey_k.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-auth-con-setuseruserkey-set-the-session-key-in-an-auth-context"> + <section id="krb5-auth-con-setuseruserkey-set-the-session-key-in-an-auth-context"> <h1>krb5_auth_con_setuseruserkey - Set the session key in an auth context.<a class="headerlink" href="#krb5-auth-con-setuseruserkey-set-the-session-key-in-an-auth-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_auth_con_setuseruserkey"> -<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_auth_con_setuseruserkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setuseruserkey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_auth_con_setuseruserkey"> +<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_auth_con_setuseruserkey</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_auth_con_setuseruserkey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[in]</strong> <strong>keyblock</strong> - User key</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>keyblock</strong> - User key</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> -</div> +</dd> +</dl> +</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_auth_con_setuseruserkey - Set the session key in an auth context.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_build_principal.html b/doc/html/appdev/refs/api/krb5_build_principal.html index 4bb5add8c9a7..93c490cc4c0a 100644 --- a/doc/html/appdev/refs/api/krb5_build_principal.html +++ b/doc/html/appdev/refs/api/krb5_build_principal.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_build_principal - Build a principal name using null-terminated strings. — 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_alloc_va - Build a principal name, using a precomputed variable argument list." href="krb5_build_principal_alloc_va.html" /> <link rel="prev" title="krb5 API" href="index.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-build-principal-build-a-principal-name-using-null-terminated-strings"> + <section id="krb5-build-principal-build-a-principal-name-using-null-terminated-strings"> <h1>krb5_build_principal - Build a principal name using null-terminated strings.<a class="headerlink" href="#krb5-build-principal-build-a-principal-name-using-null-terminated-strings" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_build_principal"> -<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_build_principal</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ</em>, unsigned int<em> rlen</em>, const char *<em> realm</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_build_principal"> +<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_build_principal</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">rlen</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>princ</strong> - Principal name</p> <p><strong>[in]</strong> <strong>rlen</strong> - Realm name length</p> -<p class="last"><strong>[in]</strong> <strong>realm</strong> - Realm name</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>realm</strong> - Realm name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Call <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>princ</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Call krb5_free_principal() to free <em>princ</em> when it is no longer needed.</p> <p>Beginning with release 1.20, the name type of the principal will be inferred as <strong>KRB5_NT_SRV_INST</strong> or <strong>KRB5_NT_WELLKNOWN</strong> based on the principal name. The type will be <strong>KRB5_NT_PRINCIPAL</strong> if a type cannot be inferred.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last"><a class="reference internal" href="#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal()</span></code></a> and <a class="reference internal" href="krb5_build_principal_alloc_va.html#c.krb5_build_principal_alloc_va" title="krb5_build_principal_alloc_va"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal_alloc_va()</span></code></a> perform the same task. <a class="reference internal" href="#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal()</span></code></a> takes variadic arguments. <a class="reference internal" href="krb5_build_principal_alloc_va.html#c.krb5_build_principal_alloc_va" title="krb5_build_principal_alloc_va"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal_alloc_va()</span></code></a> takes a pre-computed <em>varargs</em> pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>krb5_build_principal() and krb5_build_principal_alloc_va() perform the same task. krb5_build_principal() takes variadic arguments. krb5_build_principal_alloc_va() takes a pre-computed <em>varargs</em> pointer.</p> </div> +</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_build_principal - Build a principal name using null-terminated strings.</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_build_principal_alloc_va.html b/doc/html/appdev/refs/api/krb5_build_principal_alloc_va.html index d2fba62deabd..ba3999b4cf8d 100644 --- a/doc/html/appdev/refs/api/krb5_build_principal_alloc_va.html +++ b/doc/html/appdev/refs/api/krb5_build_principal_alloc_va.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_build_principal_alloc_va - Build a principal name, using a precomputed variable argument list. — 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_ext - Build a principal name using length-counted strings." href="krb5_build_principal_ext.html" /> <link rel="prev" title="krb5_build_principal - Build a principal name using null-terminated strings." href="krb5_build_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-build-principal-alloc-va-build-a-principal-name-using-a-precomputed-variable-argument-list"> + <section id="krb5-build-principal-alloc-va-build-a-principal-name-using-a-precomputed-variable-argument-list"> <h1>krb5_build_principal_alloc_va - Build a principal name, using a precomputed variable argument list.<a class="headerlink" href="#krb5-build-principal-alloc-va-build-a-principal-name-using-a-precomputed-variable-argument-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_build_principal_alloc_va"> -<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_build_principal_alloc_va</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ</em>, unsigned int<em> rlen</em>, const char *<em> realm</em>, va_list<em> ap</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_alloc_va" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_build_principal_alloc_va"> +<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_build_principal_alloc_va</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">rlen</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">ap</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_alloc_va" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>princ</strong> - Principal structure</p> <p><strong>[in]</strong> <strong>rlen</strong> - Realm name length</p> <p><strong>[in]</strong> <strong>realm</strong> - Realm name</p> -<p class="last"><strong>[in]</strong> <strong>ap</strong> - List of char * components, ending with NULL</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>ap</strong> - List of char * components, ending with NULL</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Similar to <a class="reference internal" href="krb5_build_principal.html#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_build_principal()</span></code></a> , this function builds a principal name, but its name components are specified as a va_list.</p> -<p>Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to deallocate <em>princ</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Similar to krb5_build_principal(), this function builds a principal name, but its name components are specified as a va_list.</p> +<p>Use krb5_free_principal() to deallocate <em>princ</em> when it is no longer needed.</p> +</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_build_principal_alloc_va - Build a principal name, using a precomputed variable argument list.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_build_principal_ext.html b/doc/html/appdev/refs/api/krb5_build_principal_ext.html index e89038859c9d..ec469c6e7d46 100644 --- a/doc/html/appdev/refs/api/krb5_build_principal_ext.html +++ b/doc/html/appdev/refs/api/krb5_build_principal_ext.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_build_principal_ext - Build a principal name using length-counted strings. — 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_cc_close - Close a credential cache handle." href="krb5_cc_close.html" /> <link rel="prev" title="krb5_build_principal_alloc_va - Build a principal name, using a precomputed variable argument list." href="krb5_build_principal_alloc_va.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-build-principal-ext-build-a-principal-name-using-length-counted-strings"> + <section id="krb5-build-principal-ext-build-a-principal-name-using-length-counted-strings"> <h1>krb5_build_principal_ext - Build a principal name using length-counted strings.<a class="headerlink" href="#krb5-build-principal-ext-build-a-principal-name-using-length-counted-strings" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_build_principal_ext"> -<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_build_principal_ext</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ</em>, unsigned int<em> rlen</em>, const char *<em> realm</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_ext" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_build_principal_ext"> +<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_build_principal_ext</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">rlen</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_ext" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>princ</strong> - Principal name</p> <p><strong>[in]</strong> <strong>rlen</strong> - Realm name length</p> -<p class="last"><strong>[in]</strong> <strong>realm</strong> - Realm name</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>realm</strong> - Realm name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function creates a principal from a length-counted string and a variable-length list of length-counted components. The list of components ends with the first 0 length argument (so it is not possible to specify an empty component with this function). Call <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free allocated memory for principal when it is no longer needed.</p> +</dd> +</dl> +<p>This function creates a principal from a length-counted string and a variable-length list of length-counted components. The list of components ends with the first 0 length argument (so it is not possible to specify an empty component with this function). Call krb5_free_principal() to free allocated memory for principal when it is no longer needed.</p> <p>Beginning with release 1.20, the name type of the principal will be inferred as <strong>KRB5_NT_SRV_INST</strong> or <strong>KRB5_NT_WELLKNOWN</strong> based on the principal name. The type will be <strong>KRB5_NT_PRINCIPAL</strong> if a type cannot be inferred.</p> -</div> +</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_build_principal_ext - Build a principal name using length-counted strings.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_build_principal_va.html b/doc/html/appdev/refs/api/krb5_build_principal_va.html index 883a00910b0e..bf55bd2c385e 100644 --- a/doc/html/appdev/refs/api/krb5_build_principal_va.html +++ b/doc/html/appdev/refs/api/krb5_build_principal_va.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_build_principal_va — 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_c_random_seed" href="krb5_c_random_seed.html" /> <link rel="prev" title="krb5_auth_con_initivector - Cause an auth context to use cipher state." href="krb5_auth_con_initivector.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-build-principal-va"> + <section id="krb5-build-principal-va"> <h1>krb5_build_principal_va<a class="headerlink" href="#krb5-build-principal-va" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_build_principal_va"> -<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_build_principal_va</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> princ</em>, unsigned int<em> rlen</em>, const char *<em> realm</em>, va_list<em> ap</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_va" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_build_principal_va"> +<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_build_principal_va</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">rlen</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">ap</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_build_principal_va" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>princ</strong></p> <p><strong>rlen</strong></p> <p><strong>realm</strong></p> -<p class="last"><strong>ap</strong></p> -</td> -</tr> -</tbody> -</table> -<p>DEPRECATED Replaced by krb5_build_principal_alloc_va() .</p> -</div> +<p><strong>ap</strong></p> +</dd> +</dl> +<p>DEPRECATED Replaced by krb5_build_principal_alloc_va().</p> +</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_build_principal_va</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_block_size.html b/doc/html/appdev/refs/api/krb5_c_block_size.html index bf5adb835e7c..437bfc7625b5 100644 --- a/doc/html/appdev/refs/api/krb5_c_block_size.html +++ b/doc/html/appdev/refs/api/krb5_c_block_size.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_block_size - Return cipher block size. — 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_c_checksum_length - Return the length of checksums for a checksum type." href="krb5_c_checksum_length.html" /> <link rel="prev" title="krb5_wrap_error_message - Add a prefix to a different error code’s message." href="krb5_wrap_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-block-size-return-cipher-block-size"> + <section id="krb5-c-block-size-return-cipher-block-size"> <h1>krb5_c_block_size - Return cipher block size.<a class="headerlink" href="#krb5-c-block-size-return-cipher-block-size" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_block_size"> -<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_block_size</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t *<em> blocksize</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_block_size" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_block_size"> +<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_block_size</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">blocksize</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_block_size" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> -<p class="last"><strong>[out]</strong> <strong>blocksize</strong> - Block size for <em>enctype</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>[out]</strong> <strong>blocksize</strong> - Block size for <em>enctype</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> -</div> +</dd> +</dl> +</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_c_block_size - Return cipher block size.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_checksum_length.html b/doc/html/appdev/refs/api/krb5_c_checksum_length.html index b5575aab7b1d..6b78619f9a1f 100644 --- a/doc/html/appdev/refs/api/krb5_c_checksum_length.html +++ b/doc/html/appdev/refs/api/krb5_c_checksum_length.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_checksum_length - Return the length of checksums for a checksum type. — 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_c_crypto_length - Return a length of a message field specific to the encryption type." href="krb5_c_crypto_length.html" /> <link rel="prev" title="krb5_c_block_size - Return cipher block size." href="krb5_c_block_size.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-checksum-length-return-the-length-of-checksums-for-a-checksum-type"> + <section id="krb5-c-checksum-length-return-the-length-of-checksums-for-a-checksum-type"> <h1>krb5_c_checksum_length - Return the length of checksums for a checksum type.<a class="headerlink" href="#krb5-c-checksum-length-return-the-length-of-checksums-for-a-checksum-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_checksum_length"> -<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_checksum_length</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em>, size_t *<em> length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_checksum_length" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_checksum_length"> +<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_checksum_length</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_checksum_length" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type</p> -<p class="last"><strong>[out]</strong> <strong>length</strong> - Checksum length</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>length</strong> - Checksum length</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> -</div> +</dd> +</dl> +</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_c_checksum_length - Return the length of checksums for a checksum type.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_crypto_length.html b/doc/html/appdev/refs/api/krb5_c_crypto_length.html index 125bd76e27e0..aaf5992345b2 100644 --- a/doc/html/appdev/refs/api/krb5_c_crypto_length.html +++ b/doc/html/appdev/refs/api/krb5_c_crypto_length.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_crypto_length - Return a length of a message field specific to the encryption type. — 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_c_crypto_length_iov - Fill in lengths for header, trailer and padding in a IOV array." href="krb5_c_crypto_length_iov.html" /> <link rel="prev" title="krb5_c_checksum_length - Return the length of checksums for a checksum type." href="krb5_c_checksum_length.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-crypto-length-return-a-length-of-a-message-field-specific-to-the-encryption-type"> + <section id="krb5-c-crypto-length-return-a-length-of-a-message-field-specific-to-the-encryption-type"> <h1>krb5_c_crypto_length - Return a length of a message field specific to the encryption type.<a class="headerlink" href="#krb5-c-crypto-length-return-a-length-of-a-message-field-specific-to-the-encryption-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_crypto_length"> -<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_crypto_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_cryptotype.html#c.krb5_cryptotype" title="krb5_cryptotype">krb5_cryptotype</a><em> type</em>, unsigned int *<em> size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_crypto_length" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_crypto_length"> +<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_crypto_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <a class="reference internal" href="../types/krb5_cryptotype.html#c.krb5_cryptotype" title="krb5_cryptotype"><span class="n"><span class="pre">krb5_cryptotype</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_crypto_length" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> -<p><strong>[in]</strong> <strong>type</strong> - Type field (See <code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE</span></code> types)</p> -<p class="last"><strong>[out]</strong> <strong>size</strong> - Length of the <em>type</em> specific to <em>enctype</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>type</strong> - Type field (See KRB5_CRYPTO_TYPE macros)</p> +<p><strong>[out]</strong> <strong>size</strong> - Length of the <em>type</em> specific to <em>enctype</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> -</div> +</dd> +</dl> +</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_c_crypto_length - Return a length of a message field specific to the encryption type.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_crypto_length_iov.html b/doc/html/appdev/refs/api/krb5_c_crypto_length_iov.html index 651c796ea25d..cc75f56e2f3a 100644 --- a/doc/html/appdev/refs/api/krb5_c_crypto_length_iov.html +++ b/doc/html/appdev/refs/api/krb5_c_crypto_length_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_crypto_length_iov - Fill in lengths for header, trailer and padding in a IOV array. — 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_c_decrypt - Decrypt data using a key (operates on keyblock)." href="krb5_c_decrypt.html" /> <link rel="prev" title="krb5_c_crypto_length - Return a length of a message field specific to the encryption type." href="krb5_c_crypto_length.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-crypto-length-iov-fill-in-lengths-for-header-trailer-and-padding-in-a-iov-array"> + <section id="krb5-c-crypto-length-iov-fill-in-lengths-for-header-trailer-and-padding-in-a-iov-array"> <h1>krb5_c_crypto_length_iov - Fill in lengths for header, trailer and padding in a IOV array.<a class="headerlink" href="#krb5-c-crypto-length-iov-fill-in-lengths-for-header-trailer-and-padding-in-a-iov-array" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_crypto_length_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_crypto_length_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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</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_crypto_length_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_crypto_length_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_crypto_length_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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</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_crypto_length_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[inout]</strong> <strong>data</strong> - IOV array</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> -<p>Padding is set to the actual padding required based on the provided <em>data</em> buffers. Typically this API is used after setting up the data buffers and <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_SIGN_ONLY.html#KRB5_CRYPTO_TYPE_SIGN_ONLY" title="KRB5_CRYPTO_TYPE_SIGN_ONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_SIGN_ONLY</span></code></a> buffers, but before actually allocating header, trailer and padding.</p> -</div> +</dd> +</dl> +<p>Padding is set to the actual padding required based on the provided <em>data</em> buffers. Typically this API is used after setting up the data buffers and #KRB5_CRYPTO_TYPE_SIGN_ONLY buffers, but before actually allocating header, trailer and padding.</p> +</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_c_crypto_length_iov - Fill in lengths for header, trailer and padding in a IOV array.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> 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> <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_c_decrypt_iov - Decrypt data in place supporting AEAD (operates on keyblock)." href="krb5_c_decrypt_iov.html" /> <link rel="prev" title="krb5_c_crypto_length_iov - Fill in lengths for header, trailer and padding in a IOV array." href="krb5_c_crypto_length_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <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> <dd></dd></dl> -<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> <div class="admonition note"> -<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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_c_decrypt - Decrypt data using a key (operates on keyblock).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_decrypt_iov.html b/doc/html/appdev/refs/api/krb5_c_decrypt_iov.html index fb0c95310ac8..f8133269b436 100644 --- a/doc/html/appdev/refs/api/krb5_c_decrypt_iov.html +++ b/doc/html/appdev/refs/api/krb5_c_decrypt_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_decrypt_iov - Decrypt 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> <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_c_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+)." href="krb5_c_derive_prfplus.html" /> <link rel="prev" title="krb5_c_decrypt - Decrypt data using a key (operates on keyblock)." href="krb5_c_decrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-keyblock"> + <section id="krb5-c-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-keyblock"> <h1>krb5_c_decrypt_iov - Decrypt data in place supporting AEAD (operates on keyblock).<a class="headerlink" href="#krb5-c-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_decrypt_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_decrypt_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_decrypt_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_decrypt_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_decrypt_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_decrypt_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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 decrypts the data block <em>data</em> and stores the output in-place. The actual decryption 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 decryption 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> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="#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> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">On return from a <a class="reference internal" href="#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> 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_decrypt_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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_c_decrypt_iov - Decrypt data in place supporting AEAD (operates on keyblock).</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_derive_prfplus.html b/doc/html/appdev/refs/api/krb5_c_derive_prfplus.html index ed7bf1ab5f40..302dcb753f63 100644 --- a/doc/html/appdev/refs/api/krb5_c_derive_prfplus.html +++ b/doc/html/appdev/refs/api/krb5_c_derive_prfplus.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_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+). — 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_c_encrypt - Encrypt data using a key (operates on keyblock)." href="krb5_c_encrypt.html" /> <link rel="prev" title="krb5_c_decrypt_iov - Decrypt data in place supporting AEAD (operates on keyblock)." href="krb5_c_decrypt_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-derive-prfplus-derive-a-key-using-some-input-data-via-rfc-6113-prf"> + <section id="krb5-c-derive-prfplus-derive-a-key-using-some-input-data-via-rfc-6113-prf"> <h1>krb5_c_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+).<a class="headerlink" href="#krb5-c-derive-prfplus-derive-a-key-using-some-input-data-via-rfc-6113-prf" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_derive_prfplus"> -<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_derive_prfplus</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> k</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_derive_prfplus" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_derive_prfplus"> +<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_derive_prfplus</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">k</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">input</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_derive_prfplus" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>k</strong> - KDC contribution key</p> <p><strong>[in]</strong> <strong>input</strong> - Input string</p> <p><strong>[in]</strong> <strong>enctype</strong> - Output key enctype (or <strong>ENCTYPE_NULL</strong> )</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - Derived keyblock</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>out</strong> - Derived keyblock</p> +</dd> +</dl> <p>This function uses PRF+ as defined in RFC 6113 to derive a key from another key and an input string. If <em>enctype</em> is <strong>ENCTYPE_NULL</strong> , the output key will have the same enctype as the input key.</p> -</div> +</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_c_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+).</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_encrypt.html b/doc/html/appdev/refs/api/krb5_c_encrypt.html index dddc1847ccdd..bb448adec35f 100644 --- a/doc/html/appdev/refs/api/krb5_c_encrypt.html +++ b/doc/html/appdev/refs/api/krb5_c_encrypt.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 - Encrypt 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> <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_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock)." href="krb5_c_encrypt_iov.html" /> <link rel="prev" title="krb5_c_derive_prfplus - Derive a key using some input data (via RFC 6113 PRF+)." href="krb5_c_derive_prfplus.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-encrypt-encrypt-data-using-a-key-operates-on-keyblock"> + <section id="krb5-c-encrypt-encrypt-data-using-a-key-operates-on-keyblock"> <h1>krb5_c_encrypt - Encrypt data using a key (operates on keyblock).<a class="headerlink" href="#krb5-c-encrypt-encrypt-data-using-a-key-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_encrypt"> -<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</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data">krb5_enc_data</a> *<em> output</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_encrypt"> +<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</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_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">input</span></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">output</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Data to be encrypted</p> -<p class="last"><strong>[out]</strong> <strong>output</strong> - Encrypted 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> - Encrypted 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> -<p>This function encrypts the data block <em>input</em> and stores the output into <em>output</em> . 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.</p> +</dd> +</dl> +<p>This function encrypts the data block <em>input</em> and stores the outputinto <em>output</em> . 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.</p> <div class="admonition note"> -<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 (using <a class="reference internal" href="krb5_c_encrypt_length.html#c.krb5_c_encrypt_length" title="krb5_c_encrypt_length"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_encrypt_length()</span></code></a> to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</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 (using krb5_c_encrypt_length() to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</p> </div> +</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_c_encrypt - Encrypt data using a key (operates on keyblock).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> 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> <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_c_encrypt_length - Compute encrypted data length." href="krb5_c_encrypt_length.html" /> <link rel="prev" title="krb5_c_encrypt - Encrypt data using a key (operates on keyblock)." href="krb5_c_encrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <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> <dd></dd></dl> -<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> <div class="admonition seealso"> -<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> <div class="admonition note"> -<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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <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 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_encrypt_length.html b/doc/html/appdev/refs/api/krb5_c_encrypt_length.html index 8ce9aa6b2000..674be48e0720 100644 --- a/doc/html/appdev/refs/api/krb5_c_encrypt_length.html +++ b/doc/html/appdev/refs/api/krb5_c_encrypt_length.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_length - Compute encrypted data length. — 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_c_enctype_compare - Compare two encryption types." href="krb5_c_enctype_compare.html" /> <link rel="prev" title="krb5_c_encrypt_iov - Encrypt data in place supporting AEAD (operates on keyblock)." href="krb5_c_encrypt_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-encrypt-length-compute-encrypted-data-length"> + <section id="krb5-c-encrypt-length-compute-encrypted-data-length"> <h1>krb5_c_encrypt_length - Compute encrypted data length.<a class="headerlink" href="#krb5-c-encrypt-length-compute-encrypted-data-length" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_encrypt_length"> -<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_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t<em> inputlen</em>, size_t *<em> length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt_length" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_encrypt_length"> +<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_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">inputlen</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_encrypt_length" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>inputlen</strong> - Length of the data to be encrypted</p> -<p class="last"><strong>[out]</strong> <strong>length</strong> - Length of the encrypted 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>length</strong> - Length of the encrypted 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 computes the length of the ciphertext produced by encrypting <em>inputlen</em> bytes including padding, confounder, and checksum.</p> -</div> +</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_c_encrypt_length - Compute encrypted data length.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_enctype_compare.html b/doc/html/appdev/refs/api/krb5_c_enctype_compare.html index 37786e7399e8..37c63a9b9b71 100644 --- a/doc/html/appdev/refs/api/krb5_c_enctype_compare.html +++ b/doc/html/appdev/refs/api/krb5_c_enctype_compare.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_enctype_compare - Compare two encryption types. — 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_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." href="krb5_c_free_state.html" /> + <link rel="next" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." href="krb5_c_free_state.html" /> <link rel="prev" title="krb5_c_encrypt_length - Compute encrypted data length." href="krb5_c_encrypt_length.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,7 +33,7 @@ accesskey="C">Contents</a> | <a href="krb5_c_encrypt_length.html" title="krb5_c_encrypt_length - Compute encrypted data length." accesskey="P">previous</a> | - <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." + <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-enctype-compare-compare-two-encryption-types"> + <section id="krb5-c-enctype-compare-compare-two-encryption-types"> <h1>krb5_c_enctype_compare - Compare two encryption types.<a class="headerlink" href="#krb5-c-enctype-compare-compare-two-encryption-types" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_enctype_compare"> -<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_enctype_compare</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> e1</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> e2</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> *<em> similar</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_enctype_compare" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_enctype_compare"> +<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_enctype_compare</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">e1</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">e2</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">similar</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_enctype_compare" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>e1</strong> - First encryption type</p> <p><strong>[in]</strong> <strong>e2</strong> - Second encryption type</p> -<p class="last"><strong>[out]</strong> <strong>similar</strong> - <strong>TRUE</strong> if types are similar, <strong>FALSE</strong> if not</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>similar</strong> - <strong>TRUE</strong> if types are similar, <strong>FALSE</strong> if not</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 determines whether two encryption types use the same kind of keys.</p> -</div> +</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_c_enctype_compare - Compare two encryption types.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -159,7 +145,7 @@ >Contents</a> | <a href="krb5_c_encrypt_length.html" title="krb5_c_encrypt_length - Compute encrypted data length." >previous</a> | - <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." + <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_c_free_state.html b/doc/html/appdev/refs/api/krb5_c_free_state.html index 972009c4d42b..fea8533849dc 100644 --- a/doc/html/appdev/refs/api/krb5_c_free_state.html +++ b/doc/html/appdev/refs/api/krb5_c_free_state.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" /> - <title>krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() . — 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> + <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_free_state - Free a cipher state previously allocated by krb5_c_init_state(). — MIT Kerberos Documentation</title> + <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_c_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings." href="krb5_c_fx_cf2_simple.html" /> <link rel="prev" title="krb5_c_enctype_compare - Compare two encryption types." href="krb5_c_enctype_compare.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state().">feedback</a> </div> </div> </div> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-free-state-free-a-cipher-state-previously-allocated-by-krb5-c-init-state"> -<h1>krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() .<a class="headerlink" href="#krb5-c-free-state-free-a-cipher-state-previously-allocated-by-krb5-c-init-state" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_free_state"> -<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_free_state</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> state</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_free_state" title="Permalink to this definition">¶</a></dt> + <section id="krb5-c-free-state-free-a-cipher-state-previously-allocated-by-krb5-c-init-state"> +<h1>krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state().<a class="headerlink" href="#krb5-c-free-state-free-a-cipher-state-previously-allocated-by-krb5-c-init-state" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_free_state"> +<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_free_state</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_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">state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_free_state" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Key</p> -<p class="last"><strong>[in]</strong> <strong>state</strong> - Cipher state to be freed</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>state</strong> - Cipher state to be freed</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> -</div> +</dd> +</dl> +</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_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() .</a></li> +<li><a class="reference internal" href="#">krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state().</a></li> </ul> <br/> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -163,7 +149,7 @@ >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_c_fx_cf2_simple.html b/doc/html/appdev/refs/api/krb5_c_fx_cf2_simple.html index 0ada395f4faf..165828e8be32 100644 --- a/doc/html/appdev/refs/api/krb5_c_fx_cf2_simple.html +++ b/doc/html/appdev/refs/api/krb5_c_fx_cf2_simple.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_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings. — 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_c_init_state - Initialize a new cipher state." href="krb5_c_init_state.html" /> - <link rel="prev" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." href="krb5_c_free_state.html" /> - </head> - <body> + <link rel="prev" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." href="krb5_c_free_state.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." + <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." accesskey="P">previous</a> | <a href="krb5_c_init_state.html" title="krb5_c_init_state - Initialize a new cipher state." accesskey="N">next</a> | @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-fx-cf2-simple-compute-the-krb-fx-cf2-combination-of-two-keys-and-pepper-strings"> + <section id="krb5-c-fx-cf2-simple-compute-the-krb-fx-cf2-combination-of-two-keys-and-pepper-strings"> <h1>krb5_c_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings.<a class="headerlink" href="#krb5-c-fx-cf2-simple-compute-the-krb-fx-cf2-combination-of-two-keys-and-pepper-strings" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_fx_cf2_simple"> -<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_fx_cf2_simple</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> k1</em>, const char *<em> pepper1</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> k2</em>, const char *<em> pepper2</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_fx_cf2_simple" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_fx_cf2_simple"> +<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_fx_cf2_simple</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">k1</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pepper1</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">k2</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pepper2</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_fx_cf2_simple" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>k1</strong> - KDC contribution key</p> <p><strong>[in]</strong> <strong>pepper1</strong> - String”PKINIT”</p> <p><strong>[in]</strong> <strong>k2</strong> - Reply key</p> <p><strong>[in]</strong> <strong>pepper2</strong> - String”KeyExchange”</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - Output key</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>out</strong> - Output key</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 computes the KRB-FX-CF2 function over its inputs and places the results in a newly allocated keyblock. This function is simple in that it assumes that <em>pepper1</em> and <em>pepper2</em> are C strings with no internal nulls and that the enctype of the result will be the same as that of <em>k1</em> . <em>k1</em> and <em>k2</em> may be of different enctypes.</p> -</div> +</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_c_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,14 +138,14 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state() ." + <a href="krb5_c_free_state.html" title="krb5_c_free_state - Free a cipher state previously allocated by krb5_c_init_state()." >previous</a> | <a href="krb5_c_init_state.html" title="krb5_c_init_state - Initialize a new cipher state." >next</a> | diff --git a/doc/html/appdev/refs/api/krb5_c_init_state.html b/doc/html/appdev/refs/api/krb5_c_init_state.html index 154c4e60976f..7b7d4122b049 100644 --- a/doc/html/appdev/refs/api/krb5_c_init_state.html +++ b/doc/html/appdev/refs/api/krb5_c_init_state.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_init_state - Initialize a new cipher state. — 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_c_is_coll_proof_cksum - Test whether a checksum type is collision-proof." href="krb5_c_is_coll_proof_cksum.html" /> <link rel="prev" title="krb5_c_fx_cf2_simple - Compute the KRB-FX-CF2 combination of two keys and pepper strings." href="krb5_c_fx_cf2_simple.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-init-state-initialize-a-new-cipher-state"> + <section id="krb5-c-init-state-initialize-a-new-cipher-state"> <h1>krb5_c_init_state - Initialize a new cipher state.<a class="headerlink" href="#krb5-c-init-state-initialize-a-new-cipher-state" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_init_state"> -<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_init_state</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> new_state</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_init_state" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_init_state"> +<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_init_state</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>, <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">new_state</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_init_state" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - 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 class="last"><strong>[out]</strong> <strong>new_state</strong> - New cipher state</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>usage</strong> - Key usage (see KRB5_KEYUSAGE macros)</p> +<p><strong>[out]</strong> <strong>new_state</strong> - New cipher state</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> -</div> +</dd> +</dl> +</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_c_init_state - Initialize a new cipher state.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_is_coll_proof_cksum.html b/doc/html/appdev/refs/api/krb5_c_is_coll_proof_cksum.html index 356595dd55f8..c00941b03d0e 100644 --- a/doc/html/appdev/refs/api/krb5_c_is_coll_proof_cksum.html +++ b/doc/html/appdev/refs/api/krb5_c_is_coll_proof_cksum.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_is_coll_proof_cksum - Test whether a checksum type is collision-proof. — 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_c_is_keyed_cksum - Test whether a checksum type is keyed." href="krb5_c_is_keyed_cksum.html" /> <link rel="prev" title="krb5_c_init_state - Initialize a new cipher state." href="krb5_c_init_state.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-is-coll-proof-cksum-test-whether-a-checksum-type-is-collision-proof"> + <section id="krb5-c-is-coll-proof-cksum-test-whether-a-checksum-type-is-collision-proof"> <h1>krb5_c_is_coll_proof_cksum - Test whether a checksum type is collision-proof.<a class="headerlink" href="#krb5-c-is-coll-proof-cksum-test-whether-a-checksum-type-is-collision-proof" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_is_coll_proof_cksum"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_c_is_coll_proof_cksum</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_is_coll_proof_cksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_is_coll_proof_cksum"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_c_is_coll_proof_cksum</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_is_coll_proof_cksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>ctype</strong> - Checksum type</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if ctype is collision-proof, FALSE if it is not collision-proof or not a valid checksum type.</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctype</strong> - Checksum type</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if ctype is collision-proof, FALSE if it is not collision-proof or not a valid checksum type.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_c_is_coll_proof_cksum - Test whether a checksum type is collision-proof.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_is_keyed_cksum.html b/doc/html/appdev/refs/api/krb5_c_is_keyed_cksum.html index 4b4235b1cf1d..9cbc6281f6a1 100644 --- a/doc/html/appdev/refs/api/krb5_c_is_keyed_cksum.html +++ b/doc/html/appdev/refs/api/krb5_c_is_keyed_cksum.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_is_keyed_cksum - Test whether a checksum type is keyed. — 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_c_keyed_checksum_types - Return a list of keyed checksum types usable with an encryption type." href="krb5_c_keyed_checksum_types.html" /> <link rel="prev" title="krb5_c_is_coll_proof_cksum - Test whether a checksum type is collision-proof." href="krb5_c_is_coll_proof_cksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-is-keyed-cksum-test-whether-a-checksum-type-is-keyed"> + <section id="krb5-c-is-keyed-cksum-test-whether-a-checksum-type-is-keyed"> <h1>krb5_c_is_keyed_cksum - Test whether a checksum type is keyed.<a class="headerlink" href="#krb5-c-is-keyed-cksum-test-whether-a-checksum-type-is-keyed" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_is_keyed_cksum"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_c_is_keyed_cksum</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_is_keyed_cksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_is_keyed_cksum"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_c_is_keyed_cksum</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_is_keyed_cksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>ctype</strong> - Checksum type</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if ctype is a keyed checksum type, FALSE otherwise.</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctype</strong> - Checksum type</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if ctype is a keyed checksum type, FALSE otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_c_is_keyed_cksum - Test whether a checksum type is keyed.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_keyed_checksum_types.html b/doc/html/appdev/refs/api/krb5_c_keyed_checksum_types.html index 328f68f738e0..a422300260c4 100644 --- a/doc/html/appdev/refs/api/krb5_c_keyed_checksum_types.html +++ b/doc/html/appdev/refs/api/krb5_c_keyed_checksum_types.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_keyed_checksum_types - Return a list of keyed checksum types usable with an encryption type. — 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_c_keylengths - Return length of the specified key in bytes." href="krb5_c_keylengths.html" /> <link rel="prev" title="krb5_c_is_keyed_cksum - Test whether a checksum type is keyed." href="krb5_c_is_keyed_cksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-keyed-checksum-types-return-a-list-of-keyed-checksum-types-usable-with-an-encryption-type"> + <section id="krb5-c-keyed-checksum-types-return-a-list-of-keyed-checksum-types-usable-with-an-encryption-type"> <h1>krb5_c_keyed_checksum_types - Return a list of keyed checksum types usable with an encryption type.<a class="headerlink" href="#krb5-c-keyed-checksum-types-return-a-list-of-keyed-checksum-types-usable-with-an-encryption-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_keyed_checksum_types"> -<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_keyed_checksum_types</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, unsigned int *<em> count</em>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a> **<em> cksumtypes</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_keyed_checksum_types" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_keyed_checksum_types"> +<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_keyed_checksum_types</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">count</span></span>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksumtypes</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_keyed_checksum_types" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[out]</strong> <strong>count</strong> - Count of allowable checksum types</p> -<p class="last"><strong>[out]</strong> <strong>cksumtypes</strong> - Array of allowable checksum types</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>cksumtypes</strong> - Array of allowable checksum types</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> -<p>Use <a class="reference internal" href="krb5_free_cksumtypes.html#c.krb5_free_cksumtypes" title="krb5_free_cksumtypes"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_cksumtypes()</span></code></a> to free <em>cksumtypes</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_cksumtypes() to free <em>cksumtypes</em> when it is no longer needed.</p> +</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_c_keyed_checksum_types - Return a list of keyed checksum types usable with an encryption type.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_keylengths.html b/doc/html/appdev/refs/api/krb5_c_keylengths.html index b72cecc0232e..240fa83cb5e2 100644 --- a/doc/html/appdev/refs/api/krb5_c_keylengths.html +++ b/doc/html/appdev/refs/api/krb5_c_keylengths.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_keylengths - Return length of the specified key in bytes. — 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_c_make_checksum - Compute a checksum (operates on keyblock)." href="krb5_c_make_checksum.html" /> <link rel="prev" title="krb5_c_keyed_checksum_types - Return a list of keyed checksum types usable with an encryption type." href="krb5_c_keyed_checksum_types.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-keylengths-return-length-of-the-specified-key-in-bytes"> + <section id="krb5-c-keylengths-return-length-of-the-specified-key-in-bytes"> <h1>krb5_c_keylengths - Return length of the specified key in bytes.<a class="headerlink" href="#krb5-c-keylengths-return-length-of-the-specified-key-in-bytes" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_keylengths"> -<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_keylengths</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t *<em> keybytes</em>, size_t *<em> keylength</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_keylengths" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_keylengths"> +<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_keylengths</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">keybytes</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">keylength</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_keylengths" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[out]</strong> <strong>keybytes</strong> - Number of bytes required to make a key</p> -<p class="last"><strong>[out]</strong> <strong>keylength</strong> - Length of final key</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>keylength</strong> - Length of final key</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> -</div> +</dd> +</dl> +</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_c_keylengths - Return length of the specified key in bytes.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_make_checksum.html b/doc/html/appdev/refs/api/krb5_c_make_checksum.html index 9f6502488478..ffdde623d6b4 100644 --- a/doc/html/appdev/refs/api/krb5_c_make_checksum.html +++ b/doc/html/appdev/refs/api/krb5_c_make_checksum.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_make_checksum - Compute a checksum (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> <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_c_make_checksum_iov - Fill in a checksum element in IOV array (operates on keyblock)" href="krb5_c_make_checksum_iov.html" /> <link rel="prev" title="krb5_c_keylengths - Return length of the specified key in bytes." href="krb5_c_keylengths.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-make-checksum-compute-a-checksum-operates-on-keyblock"> + <section id="krb5-c-make-checksum-compute-a-checksum-operates-on-keyblock"> <h1>krb5_c_make_checksum - Compute a checksum (operates on keyblock).<a class="headerlink" href="#krb5-c-make-checksum-compute-a-checksum-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_make_checksum"> -<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_make_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</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> input</em>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> cksum</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_make_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_make_checksum"> +<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_make_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</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">input</span></span>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksum</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_make_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>input</strong> - Input data</p> -<p class="last"><strong>[out]</strong> <strong>cksum</strong> - Generated checksum</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>cksum</strong> - Generated checksum</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> -<p>This function computes a checksum of type <em>cksumtype</em> over <em>input</em> , using <em>key</em> if the checksum type is a keyed checksum. If <em>cksumtype</em> is 0 and <em>key</em> is non-null, the checksum type will be the mandatory-to-implement checksum type for the key’s encryption type. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type. The newly created <em>cksum</em> must be released by calling <a class="reference internal" href="krb5_free_checksum_contents.html#c.krb5_free_checksum_contents" title="krb5_free_checksum_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_checksum_contents()</span></code></a> when it is no longer needed.</p> +</dd> +</dl> +<p>This function computes a checksum of type <em>cksumtype</em> over <em>input</em> , using <em>key</em> if the checksum type is a keyed checksum. If <em>cksumtype</em> is 0 and <em>key</em> is non-null, the checksum type will be the mandatory-to-implement checksum type for the key’s encryption type. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type. The newly created <em>cksum</em> must be released by calling krb5_free_checksum_contents() when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_c_verify_checksum.html#c.krb5_c_verify_checksum" title="krb5_c_verify_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_verify_checksum()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_c_verify_checksum()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_k_make_checksum.html#c.krb5_k_make_checksum" title="krb5_k_make_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_make_checksum()</span></code></a> , but operates on keyblock <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_k_make_checksum(), but operates on keyblock <em>key</em> .</p> </div> +</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_c_make_checksum - Compute a checksum (operates on keyblock).</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_make_checksum_iov.html b/doc/html/appdev/refs/api/krb5_c_make_checksum_iov.html index 0239facf1ac4..d9b1341f7638 100644 --- a/doc/html/appdev/refs/api/krb5_c_make_checksum_iov.html +++ b/doc/html/appdev/refs/api/krb5_c_make_checksum_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_make_checksum_iov - Fill in a checksum element in IOV array (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> <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_c_make_random_key - Generate an enctype-specific random encryption key." href="krb5_c_make_random_key.html" /> <link rel="prev" title="krb5_c_make_checksum - Compute a checksum (operates on keyblock)." href="krb5_c_make_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-keyblock"> + <section id="krb5-c-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-keyblock"> <h1>krb5_c_make_checksum_iov - Fill in a checksum element in IOV array (operates on keyblock)<a class="headerlink" href="#krb5-c-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_make_checksum_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_make_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</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>, <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_make_checksum_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_make_checksum_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_make_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</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>, <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_make_checksum_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>data</strong> - IOV array</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> -<p>Create a checksum in the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> element over <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_DATA.html#KRB5_CRYPTO_TYPE_DATA" title="KRB5_CRYPTO_TYPE_DATA"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_DATA</span></code></a> and <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_SIGN_ONLY.html#KRB5_CRYPTO_TYPE_SIGN_ONLY" title="KRB5_CRYPTO_TYPE_SIGN_ONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_SIGN_ONLY</span></code></a> chunks in <em>data</em> . Only the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> region is modified.</p> +</dd> +</dl> +<p>Create a checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element over #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY chunks in <em>data</em> . Only the #KRB5_CRYPTO_TYPE_CHECKSUM region is modified.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_c_verify_checksum_iov.html#c.krb5_c_verify_checksum_iov" title="krb5_c_verify_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_verify_checksum_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_c_verify_checksum_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_k_make_checksum_iov.html#c.krb5_k_make_checksum_iov" title="krb5_k_make_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_make_checksum_iov()</span></code></a> , but operates on keyblock <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_k_make_checksum_iov(), but operates on keyblock <em>key</em> .</p> </div> +</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_c_make_checksum_iov - Fill in a checksum element in IOV array (operates on keyblock)</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_make_random_key.html b/doc/html/appdev/refs/api/krb5_c_make_random_key.html index ba1fa57f8af3..3ad46d16937f 100644 --- a/doc/html/appdev/refs/api/krb5_c_make_random_key.html +++ b/doc/html/appdev/refs/api/krb5_c_make_random_key.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_make_random_key - Generate an enctype-specific random encryption key. — 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_c_padding_length - Return a number of padding octets." href="krb5_c_padding_length.html" /> <link rel="prev" title="krb5_c_make_checksum_iov - Fill in a checksum element in IOV array (operates on keyblock)" href="krb5_c_make_checksum_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-make-random-key-generate-an-enctype-specific-random-encryption-key"> + <section id="krb5-c-make-random-key-generate-an-enctype-specific-random-encryption-key"> <h1>krb5_c_make_random_key - Generate an enctype-specific random encryption key.<a class="headerlink" href="#krb5-c-make-random-key-generate-an-enctype-specific-random-encryption-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_make_random_key"> -<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_make_random_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> k5_random_key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_make_random_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_make_random_key"> +<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_make_random_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></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">k5_random_key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_make_random_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type of the generated key</p> -<p class="last"><strong>[out]</strong> <strong>k5_random_key</strong> - An allocated and initialized keyblock</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>k5_random_key</strong> - An allocated and initialized keyblock</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> -<p>Use <a class="reference internal" href="krb5_free_keyblock_contents.html#c.krb5_free_keyblock_contents" title="krb5_free_keyblock_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock_contents()</span></code></a> to free <em>k5_random_key</em> when no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_keyblock_contents() to free <em>k5_random_key</em> when no longer needed.</p> +</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_c_make_random_key - Generate an enctype-specific random encryption key.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_padding_length.html b/doc/html/appdev/refs/api/krb5_c_padding_length.html index 8ebcdec35869..0efa8703e2c2 100644 --- a/doc/html/appdev/refs/api/krb5_c_padding_length.html +++ b/doc/html/appdev/refs/api/krb5_c_padding_length.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_padding_length - Return a number of padding octets. — 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_c_prf - Generate enctype-specific pseudo-random bytes." href="krb5_c_prf.html" /> <link rel="prev" title="krb5_c_make_random_key - Generate an enctype-specific random encryption key." href="krb5_c_make_random_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-padding-length-return-a-number-of-padding-octets"> + <section id="krb5-c-padding-length-return-a-number-of-padding-octets"> <h1>krb5_c_padding_length - Return a number of padding octets.<a class="headerlink" href="#krb5-c-padding-length-return-a-number-of-padding-octets" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_padding_length"> -<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_padding_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t<em> data_length</em>, unsigned int *<em> size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_padding_length" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_padding_length"> +<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_padding_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">data_length</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_padding_length" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>data_length</strong> - Length of the plaintext to pad</p> -<p class="last"><strong>[out]</strong> <strong>size</strong> - Number of padding octets</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 - KRB5_BAD_ENCTYPE</li> +<p><strong>[out]</strong> <strong>size</strong> - Number of padding octets</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 - KRB5_BAD_ENCTYPE</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function returns the number of the padding octets required to pad <em>data_length</em> octets of plaintext.</p> -</div> +</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_c_padding_length - Return a number of padding octets.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_prf.html b/doc/html/appdev/refs/api/krb5_c_prf.html index bd6decf15a6a..656241f42ba4 100644 --- a/doc/html/appdev/refs/api/krb5_c_prf.html +++ b/doc/html/appdev/refs/api/krb5_c_prf.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_prf - Generate enctype-specific pseudo-random bytes. — 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_c_prfplus - Generate pseudo-random bytes using RFC 6113 PRF+." href="krb5_c_prfplus.html" /> <link rel="prev" title="krb5_c_padding_length - Return a number of padding octets." href="krb5_c_padding_length.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-prf-generate-enctype-specific-pseudo-random-bytes"> + <section id="krb5-c-prf-generate-enctype-specific-pseudo-random-bytes"> <h1>krb5_c_prf - Generate enctype-specific pseudo-random bytes.<a class="headerlink" href="#krb5-c-prf-generate-enctype-specific-pseudo-random-bytes" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_prf"> -<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_prf</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_data.html#c.krb5_data" title="krb5_data">krb5_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_prf" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_prf"> +<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_prf</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_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">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_prf" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Key</p> <p><strong>[in]</strong> <strong>input</strong> - Input data</p> -<p class="last"><strong>[out]</strong> <strong>output</strong> - Output 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> - Output 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> -<p>This function selects a pseudo-random function based on <em>keyblock</em> and computes its value over <em>input</em> , placing the result into <em>output</em> . The caller must preinitialize <em>output</em> and allocate space for the result, using <a class="reference internal" href="krb5_c_prf_length.html#c.krb5_c_prf_length" title="krb5_c_prf_length"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_prf_length()</span></code></a> to determine the required length.</p> -</div> +</dd> +</dl> +<p>This function selects a pseudo-random function based on <em>keyblock</em> and computes its value over <em>input</em> , placing the result into <em>output</em> . The caller must preinitialize <em>output</em> and allocate space for the result, using krb5_c_prf_length() to determine the required length.</p> +</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_c_prf - Generate enctype-specific pseudo-random bytes.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_prf_length.html b/doc/html/appdev/refs/api/krb5_c_prf_length.html index 7bcf350c207b..b9f9fb2a929b 100644 --- a/doc/html/appdev/refs/api/krb5_c_prf_length.html +++ b/doc/html/appdev/refs/api/krb5_c_prf_length.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_prf_length - Get the output length of pseudo-random functions for an encryption type. — 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_c_random_add_entropy" href="krb5_c_random_add_entropy.html" /> <link rel="prev" title="krb5_c_prfplus - Generate pseudo-random bytes using RFC 6113 PRF+." href="krb5_c_prfplus.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-prf-length-get-the-output-length-of-pseudo-random-functions-for-an-encryption-type"> + <section id="krb5-c-prf-length-get-the-output-length-of-pseudo-random-functions-for-an-encryption-type"> <h1>krb5_c_prf_length - Get the output length of pseudo-random functions for an encryption type.<a class="headerlink" href="#krb5-c-prf-length-get-the-output-length-of-pseudo-random-functions-for-an-encryption-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_prf_length"> -<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_prf_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t *<em> len</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_prf_length" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_prf_length"> +<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_prf_length</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">len</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_prf_length" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> -<p class="last"><strong>[out]</strong> <strong>len</strong> - Length of PRF output</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>len</strong> - Length of PRF output</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> -</div> +</dd> +</dl> +</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_c_prf_length - Get the output length of pseudo-random functions for an encryption type.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_prfplus.html b/doc/html/appdev/refs/api/krb5_c_prfplus.html index 2ba8199a8811..1308bffa5444 100644 --- a/doc/html/appdev/refs/api/krb5_c_prfplus.html +++ b/doc/html/appdev/refs/api/krb5_c_prfplus.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_prfplus - Generate pseudo-random bytes using RFC 6113 PRF+. — 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_c_prf_length - Get the output length of pseudo-random functions for an encryption type." href="krb5_c_prf_length.html" /> <link rel="prev" title="krb5_c_prf - Generate enctype-specific pseudo-random bytes." href="krb5_c_prf.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-prfplus-generate-pseudo-random-bytes-using-rfc-6113-prf"> + <section id="krb5-c-prfplus-generate-pseudo-random-bytes-using-rfc-6113-prf"> <h1>krb5_c_prfplus - Generate pseudo-random bytes using RFC 6113 PRF+.<a class="headerlink" href="#krb5-c-prfplus-generate-pseudo-random-bytes-using-rfc-6113-prf" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_prfplus"> -<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_prfplus</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> k</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_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_prfplus" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_prfplus"> +<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_prfplus</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">k</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">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_prfplus" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>k</strong> - KDC contribution key</p> <p><strong>[in]</strong> <strong>input</strong> - Input data</p> -<p class="last"><strong>[out]</strong> <strong>output</strong> - Pseudo-random output buffer</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>0 on success, E2BIG if output->length is too large for PRF+ to generate, ENOMEM on allocation failure, or an error code from krb5_c_prf()</li> +<p><strong>[out]</strong> <strong>output</strong> - Pseudo-random output buffer</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 on success, E2BIG if output->length is too large for PRF+ to generate, ENOMEM on allocation failure, or an error code from krb5_c_prf()</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function fills <em>output</em> with PRF+(k, input) as defined in RFC 6113 section 5.1. The caller must preinitialize <em>output</em> and allocate the desired amount of space. The length of the pseudo-random output will match the length of <em>output</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">RFC 4402 defines a different PRF+ operation. This function does not implement that operation.</p> -</div> +<p class="admonition-title">Note</p> +<p>RFC 4402 defines a different PRF+ operation. This function does not implement that operation.</p> </div> +</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_c_prfplus - Generate pseudo-random bytes using RFC 6113 PRF+.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_random_add_entropy.html b/doc/html/appdev/refs/api/krb5_c_random_add_entropy.html index 7c70a17ab79e..4486b2c0a16f 100644 --- a/doc/html/appdev/refs/api/krb5_c_random_add_entropy.html +++ b/doc/html/appdev/refs/api/krb5_c_random_add_entropy.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_random_add_entropy — 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_c_random_make_octets - Generate pseudo-random bytes." href="krb5_c_random_make_octets.html" /> <link rel="prev" title="krb5_c_prf_length - Get the output length of pseudo-random functions for an encryption type." href="krb5_c_prf_length.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-random-add-entropy"> + <section id="krb5-c-random-add-entropy"> <h1>krb5_c_random_add_entropy<a class="headerlink" href="#krb5-c-random-add-entropy" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_random_add_entropy"> -<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_random_add_entropy</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>, unsigned int<em> randsource</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_add_entropy" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_random_add_entropy"> +<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_random_add_entropy</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="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">randsource</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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_add_entropy" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>randsource</strong></p> -<p class="last"><strong>data</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>data</strong></p> +</dd> +</dl> <p>DEPRECATED This call is no longer necessary.</p> -</div> +</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_c_random_add_entropy</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_random_make_octets.html b/doc/html/appdev/refs/api/krb5_c_random_make_octets.html index 24adbb3f37a0..c917e7a184f6 100644 --- a/doc/html/appdev/refs/api/krb5_c_random_make_octets.html +++ b/doc/html/appdev/refs/api/krb5_c_random_make_octets.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_random_make_octets - Generate pseudo-random bytes. — 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_c_random_os_entropy" href="krb5_c_random_os_entropy.html" /> <link rel="prev" title="krb5_c_random_add_entropy" href="krb5_c_random_add_entropy.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-random-make-octets-generate-pseudo-random-bytes"> + <section id="krb5-c-random-make-octets-generate-pseudo-random-bytes"> <h1>krb5_c_random_make_octets - Generate pseudo-random bytes.<a class="headerlink" href="#krb5-c-random-make-octets-generate-pseudo-random-bytes" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_random_make_octets"> -<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_random_make_octets</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_make_octets" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_random_make_octets"> +<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_random_make_octets</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>, <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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_make_octets" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>data</strong> - Random 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> +<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>[out]</strong> <strong>data</strong> - Random 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>Fills in <em>data</em> with bytes from the PRNG used by krb5 crypto operations. The caller must preinitialize <em>data</em> and allocate the desired amount of space.</p> -</div> +</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_c_random_make_octets - Generate pseudo-random bytes.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_random_os_entropy.html b/doc/html/appdev/refs/api/krb5_c_random_os_entropy.html index bdc993c15a41..08a47c82590d 100644 --- a/doc/html/appdev/refs/api/krb5_c_random_os_entropy.html +++ b/doc/html/appdev/refs/api/krb5_c_random_os_entropy.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_random_os_entropy — 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_c_random_to_key - Generate an enctype-specific key from random data." href="krb5_c_random_to_key.html" /> <link rel="prev" title="krb5_c_random_make_octets - Generate pseudo-random bytes." href="krb5_c_random_make_octets.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-random-os-entropy"> + <section id="krb5-c-random-os-entropy"> <h1>krb5_c_random_os_entropy<a class="headerlink" href="#krb5-c-random-os-entropy" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_random_os_entropy"> -<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_random_os_entropy</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>, int<em> strong</em>, int *<em> success</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_os_entropy" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_random_os_entropy"> +<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_random_os_entropy</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="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">strong</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">success</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_os_entropy" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>strong</strong></p> -<p class="last"><strong>success</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>success</strong></p> +</dd> +</dl> <p>DEPRECATED This call is no longer necessary.</p> -</div> +</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_c_random_os_entropy</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_random_seed.html b/doc/html/appdev/refs/api/krb5_c_random_seed.html index 32a0ca2e0945..44749637b09b 100644 --- a/doc/html/appdev/refs/api/krb5_c_random_seed.html +++ b/doc/html/appdev/refs/api/krb5_c_random_seed.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_random_seed — 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_calculate_checksum" href="krb5_calculate_checksum.html" /> <link rel="prev" title="krb5_build_principal_va" href="krb5_build_principal_va.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-random-seed"> + <section id="krb5-c-random-seed"> <h1>krb5_c_random_seed<a class="headerlink" href="#krb5-c-random-seed" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_random_seed"> -<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_random_seed</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_seed" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_random_seed"> +<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_random_seed</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>, <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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_seed" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>data</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>data</strong></p> +</dd> +</dl> <p>DEPRECATED This call is no longer necessary.</p> -</div> +</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_c_random_seed</a></li> @@ -130,6 +119,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_random_to_key.html b/doc/html/appdev/refs/api/krb5_c_random_to_key.html index ae2f167bbe4e..961108e29702 100644 --- a/doc/html/appdev/refs/api/krb5_c_random_to_key.html +++ b/doc/html/appdev/refs/api/krb5_c_random_to_key.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_random_to_key - Generate an enctype-specific key from random data. — 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_c_string_to_key - Convert a string (such a password) to a key." href="krb5_c_string_to_key.html" /> <link rel="prev" title="krb5_c_random_os_entropy" href="krb5_c_random_os_entropy.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-random-to-key-generate-an-enctype-specific-key-from-random-data"> + <section id="krb5-c-random-to-key-generate-an-enctype-specific-key-from-random-data"> <h1>krb5_c_random_to_key - Generate an enctype-specific key from random data.<a class="headerlink" href="#krb5-c-random-to-key-generate-an-enctype-specific-key-from-random-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_random_to_key"> -<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_random_to_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> random_data</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> k5_random_key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_to_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_random_to_key"> +<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_random_to_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</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">random_data</span></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">k5_random_key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_random_to_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>random_data</strong> - Random input data</p> -<p class="last"><strong>[out]</strong> <strong>k5_random_key</strong> - Resulting key</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>k5_random_key</strong> - Resulting key</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 takes random input data <em>random_data</em> and produces a valid key <em>k5_random_key</em> for a given <em>enctype</em> .</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_c_keylengths.html#c.krb5_c_keylengths" title="krb5_c_keylengths"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_keylengths()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_c_keylengths()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">It is assumed that <em>k5_random_key</em> has already been initialized and <em>k5_random_key->contents</em> has been allocated with the correct length.</p> -</div> +<p class="admonition-title">Note</p> +<p>It is assumed that <em>k5_random_key</em> has already been initialized and <em>k5_random_key->contents</em> has been allocated with the correct length.</p> </div> +</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_c_random_to_key - Generate an enctype-specific key from random data.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_string_to_key.html b/doc/html/appdev/refs/api/krb5_c_string_to_key.html index 4d852976ee47..6e57770812f7 100644 --- a/doc/html/appdev/refs/api/krb5_c_string_to_key.html +++ b/doc/html/appdev/refs/api/krb5_c_string_to_key.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_string_to_key - Convert a string (such a password) to a key. — 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_c_string_to_key_with_params - Convert a string (such as a password) to a key with additional parameters." href="krb5_c_string_to_key_with_params.html" /> <link rel="prev" title="krb5_c_random_to_key - Generate an enctype-specific key from random data." href="krb5_c_random_to_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-string-to-key-convert-a-string-such-a-password-to-a-key"> + <section id="krb5-c-string-to-key-convert-a-string-such-a-password-to-a-key"> <h1>krb5_c_string_to_key - Convert a string (such a password) to a key.<a class="headerlink" href="#krb5-c-string-to-key-convert-a-string-such-a-password-to-a-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_string_to_key"> -<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_string_to_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> string</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> salt</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_string_to_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_string_to_key"> +<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_string_to_key</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</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">string</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">salt</span></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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_string_to_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>string</strong> - String to be converted</p> <p><strong>[in]</strong> <strong>salt</strong> - Salt value</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Generated key</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>key</strong> - Generated key</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> -<p>This function converts <em>string</em> to a <em>key</em> of encryption type <em>enctype</em> , using the specified <em>salt</em> . The newly created <em>key</em> must be released by calling <a class="reference internal" href="krb5_free_keyblock_contents.html#c.krb5_free_keyblock_contents" title="krb5_free_keyblock_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock_contents()</span></code></a> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function converts <em>string</em> to a <em>key</em> of encryption type <em>enctype</em> , using the specified <em>salt</em> . The newly created <em>key</em> must be released by calling krb5_free_keyblock_contents() when it is no longer needed.</p> +</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_c_string_to_key - Convert a string (such a password) to a key.</a></li> @@ -144,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_string_to_key_with_params.html b/doc/html/appdev/refs/api/krb5_c_string_to_key_with_params.html index cd7fafbee1ae..a2a1a14d3faa 100644 --- a/doc/html/appdev/refs/api/krb5_c_string_to_key_with_params.html +++ b/doc/html/appdev/refs/api/krb5_c_string_to_key_with_params.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_string_to_key_with_params - Convert a string (such as a password) to a key with additional parameters. — 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_c_valid_cksumtype - Verify that specified checksum type is a valid Kerberos checksum type." href="krb5_c_valid_cksumtype.html" /> <link rel="prev" title="krb5_c_string_to_key - Convert a string (such a password) to a key." href="krb5_c_string_to_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-string-to-key-with-params-convert-a-string-such-as-a-password-to-a-key-with-additional-parameters"> + <section id="krb5-c-string-to-key-with-params-convert-a-string-such-as-a-password-to-a-key-with-additional-parameters"> <h1>krb5_c_string_to_key_with_params - Convert a string (such as a password) to a key with additional parameters.<a class="headerlink" href="#krb5-c-string-to-key-with-params-convert-a-string-such-as-a-password-to-a-key-with-additional-parameters" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_string_to_key_with_params"> -<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_string_to_key_with_params</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> string</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> salt</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> params</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_string_to_key_with_params" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_string_to_key_with_params"> +<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_string_to_key_with_params</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</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">string</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">salt</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">params</span></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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_string_to_key_with_params" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>string</strong> - String to be converted</p> <p><strong>[in]</strong> <strong>salt</strong> - Salt value</p> <p><strong>[in]</strong> <strong>params</strong> - Parameters</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Generated key</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>key</strong> - Generated key</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> -<p>This function is similar to <a class="reference internal" href="krb5_c_string_to_key.html#c.krb5_c_string_to_key" title="krb5_c_string_to_key"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_string_to_key()</span></code></a> , but also takes parameters which may affect the algorithm in an enctype-dependent way. The newly created <em>key</em> must be released by calling <a class="reference internal" href="krb5_free_keyblock_contents.html#c.krb5_free_keyblock_contents" title="krb5_free_keyblock_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock_contents()</span></code></a> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function is similar to krb5_c_string_to_key(), but also takes parameters which may affect the algorithm in an enctype-dependent way. The newly created <em>key</em> must be released by calling krb5_free_keyblock_contents() when it is no longer needed.</p> +</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_c_string_to_key_with_params - Convert a string (such as a password) to a key with additional parameters.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_valid_cksumtype.html b/doc/html/appdev/refs/api/krb5_c_valid_cksumtype.html index 3a1bbf990653..e37da7bf2081 100644 --- a/doc/html/appdev/refs/api/krb5_c_valid_cksumtype.html +++ b/doc/html/appdev/refs/api/krb5_c_valid_cksumtype.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_valid_cksumtype - Verify that specified checksum type is a valid Kerberos checksum type. — 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_c_valid_enctype - Verify that a specified encryption type is a valid Kerberos encryption type." href="krb5_c_valid_enctype.html" /> <link rel="prev" title="krb5_c_string_to_key_with_params - Convert a string (such as a password) to a key with additional parameters." href="krb5_c_string_to_key_with_params.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-valid-cksumtype-verify-that-specified-checksum-type-is-a-valid-kerberos-checksum-type"> + <section id="krb5-c-valid-cksumtype-verify-that-specified-checksum-type-is-a-valid-kerberos-checksum-type"> <h1>krb5_c_valid_cksumtype - Verify that specified checksum type is a valid Kerberos checksum type.<a class="headerlink" href="#krb5-c-valid-cksumtype-verify-that-specified-checksum-type-is-a-valid-kerberos-checksum-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_valid_cksumtype"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_c_valid_cksumtype</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_valid_cksumtype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_valid_cksumtype"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_c_valid_cksumtype</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_valid_cksumtype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>ctype</strong> - Checksum type</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if ctype is valid, FALSE if not</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctype</strong> - Checksum type</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if ctype is valid, FALSE if not</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_c_valid_cksumtype - Verify that specified checksum type is a valid Kerberos checksum type.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_valid_enctype.html b/doc/html/appdev/refs/api/krb5_c_valid_enctype.html index 016e588e920b..3eb00ff93c80 100644 --- a/doc/html/appdev/refs/api/krb5_c_valid_enctype.html +++ b/doc/html/appdev/refs/api/krb5_c_valid_enctype.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_valid_enctype - Verify that a specified encryption type is a valid Kerberos encryption type. — 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_c_verify_checksum - Verify a checksum (operates on keyblock)." href="krb5_c_verify_checksum.html" /> <link rel="prev" title="krb5_c_valid_cksumtype - Verify that specified checksum type is a valid Kerberos checksum type." href="krb5_c_valid_cksumtype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-valid-enctype-verify-that-a-specified-encryption-type-is-a-valid-kerberos-encryption-type"> + <section id="krb5-c-valid-enctype-verify-that-a-specified-encryption-type-is-a-valid-kerberos-encryption-type"> <h1>krb5_c_valid_enctype - Verify that a specified encryption type is a valid Kerberos encryption type.<a class="headerlink" href="#krb5-c-valid-enctype-verify-that-a-specified-encryption-type-is-a-valid-kerberos-encryption-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_valid_enctype"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_c_valid_enctype</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> ktype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_valid_enctype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_valid_enctype"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_c_valid_enctype</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ktype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_valid_enctype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>ktype</strong> - Encryption type</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if ktype is valid, FALSE if not</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ktype</strong> - Encryption type</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if ktype is valid, FALSE if not</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_c_valid_enctype - Verify that a specified encryption type is a valid Kerberos encryption type.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_verify_checksum.html b/doc/html/appdev/refs/api/krb5_c_verify_checksum.html index 77ace596cc0a..e2d99c29d653 100644 --- a/doc/html/appdev/refs/api/krb5_c_verify_checksum.html +++ b/doc/html/appdev/refs/api/krb5_c_verify_checksum.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_verify_checksum - Verify a checksum (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> <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_c_verify_checksum_iov - Validate a checksum element in IOV array (operates on keyblock)." href="krb5_c_verify_checksum_iov.html" /> <link rel="prev" title="krb5_c_valid_enctype - Verify that a specified encryption type is a valid Kerberos encryption type." href="krb5_c_valid_enctype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-verify-checksum-verify-a-checksum-operates-on-keyblock"> + <section id="krb5-c-verify-checksum-verify-a-checksum-operates-on-keyblock"> <h1>krb5_c_verify_checksum - Verify a checksum (operates on keyblock).<a class="headerlink" href="#krb5-c-verify-checksum-verify-a-checksum-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_verify_checksum"> -<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_verify_checksum</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> data</em>, const <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> cksum</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> *<em> valid</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_verify_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_verify_checksum"> +<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_verify_checksum</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">data</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksum</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_verify_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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 for a keyed checksum</p> <p><strong>[in]</strong> <strong>usage</strong> - <em>key</em> usage</p> <p><strong>[in]</strong> <strong>data</strong> - Data to be used to compute a new checksum using <em>key</em> to compare <em>cksum</em> against</p> <p><strong>[in]</strong> <strong>cksum</strong> - Checksum to be verified</p> -<p class="last"><strong>[out]</strong> <strong>valid</strong> - Non-zero for success, zero for failure</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>valid</strong> - Non-zero for success, zero for failure</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 verifies that <em>cksum</em> is a valid checksum for <em>data</em> . If the checksum type of <em>cksum</em> is a keyed checksum, <em>key</em> is used to verify the checksum. If the checksum type in <em>cksum</em> is 0 and <em>key</em> is not NULL, the mandatory checksum type for <em>key</em> will be used. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_k_verify_checksum.html#c.krb5_k_verify_checksum" title="krb5_k_verify_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_verify_checksum()</span></code></a> , but operates on keyblock <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_k_verify_checksum(), but operates on keyblock <em>key</em> .</p> </div> +</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_c_verify_checksum - Verify a checksum (operates on keyblock).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_c_verify_checksum_iov.html b/doc/html/appdev/refs/api/krb5_c_verify_checksum_iov.html index 2e2dc8bf86bb..ce0c9699d4e3 100644 --- a/doc/html/appdev/refs/api/krb5_c_verify_checksum_iov.html +++ b/doc/html/appdev/refs/api/krb5_c_verify_checksum_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_verify_checksum_iov - Validate a checksum element in IOV array (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> <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_cksumtype_to_string - Convert a checksum type to a string." href="krb5_cksumtype_to_string.html" /> <link rel="prev" title="krb5_c_verify_checksum - Verify a checksum (operates on keyblock)." href="krb5_c_verify_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,56 +52,50 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-c-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-keyblock"> + <section id="krb5-c-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-keyblock"> <h1>krb5_c_verify_checksum_iov - Validate a checksum element in IOV array (operates on keyblock).<a class="headerlink" href="#krb5-c-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_c_verify_checksum_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_verify_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</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_crypto_iov.html#c.krb5_crypto_iov" title="krb5_crypto_iov">krb5_crypto_iov</a> *<em> data</em>, size_t<em> num_data</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> *<em> valid</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_verify_checksum_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_c_verify_checksum_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_verify_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</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_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>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_c_verify_checksum_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>data</strong> - IOV array</p> <p><strong>[in]</strong> <strong>num_data</strong> - Size of <em>data</em></p> -<p class="last"><strong>[out]</strong> <strong>valid</strong> - Non-zero for success, zero for failure</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>valid</strong> - Non-zero for success, zero for failure</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> -<p>Confirm that the checksum in the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> element is a valid checksum of the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_DATA.html#KRB5_CRYPTO_TYPE_DATA" title="KRB5_CRYPTO_TYPE_DATA"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_DATA</span></code></a> and <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_SIGN_ONLY.html#KRB5_CRYPTO_TYPE_SIGN_ONLY" title="KRB5_CRYPTO_TYPE_SIGN_ONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_SIGN_ONLY</span></code></a> regions in the iov.</p> +</dd> +</dl> +<p>Confirm that the checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element is a valid checksum of the #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY regions in the iov.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_c_make_checksum_iov.html#c.krb5_c_make_checksum_iov" title="krb5_c_make_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_make_checksum_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_c_make_checksum_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_k_verify_checksum_iov.html#c.krb5_k_verify_checksum_iov" title="krb5_k_verify_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_verify_checksum_iov()</span></code></a> , but operates on keyblock <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_k_verify_checksum_iov(), but operates on keyblock <em>key</em> .</p> </div> +</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_c_verify_checksum_iov - Validate a checksum element in IOV array (operates on keyblock).</a></li> @@ -154,6 +139,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -161,8 +147,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_calculate_checksum.html b/doc/html/appdev/refs/api/krb5_calculate_checksum.html index defe2ab970e9..7d4298897602 100644 --- a/doc/html/appdev/refs/api/krb5_calculate_checksum.html +++ b/doc/html/appdev/refs/api/krb5_calculate_checksum.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_calculate_checksum — 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_checksum_size" href="krb5_checksum_size.html" /> <link rel="prev" title="krb5_c_random_seed" href="krb5_c_random_seed.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-calculate-checksum"> + <section id="krb5-calculate-checksum"> <h1>krb5_calculate_checksum<a class="headerlink" href="#krb5-calculate-checksum" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_calculate_checksum"> -<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_calculate_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> in</em>, size_t<em> in_length</em>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> seed</em>, size_t<em> seed_length</em>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> outcksum</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_calculate_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_calculate_checksum"> +<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_calculate_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">in</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">in_length</span></span>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">seed</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">seed_length</span></span>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outcksum</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_calculate_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>ctype</strong></p> <p><strong>in</strong></p> <p><strong>in_length</strong></p> <p><strong>seed</strong></p> <p><strong>seed_length</strong></p> -<p class="last"><strong>outcksum</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>outcksum</strong></p> +</dd> +</dl> <p>DEPRECATED See krb5_c_make_checksum()</p> -</div> +</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_calculate_checksum</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_cache_match.html b/doc/html/appdev/refs/api/krb5_cc_cache_match.html index 8dcb9efa452e..8f858217961b 100644 --- a/doc/html/appdev/refs/api/krb5_cc_cache_match.html +++ b/doc/html/appdev/refs/api/krb5_cc_cache_match.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_cc_cache_match - Find a credential cache with a specified client principal. — 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_cc_copy_creds - Copy a credential cache." href="krb5_cc_copy_creds.html" /> <link rel="prev" title="krb5_auth_con_setuseruserkey - Set the session key in an auth context." href="krb5_auth_con_setuseruserkey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-cache-match-find-a-credential-cache-with-a-specified-client-principal"> + <section id="krb5-cc-cache-match-find-a-credential-cache-with-a-specified-client-principal"> <h1>krb5_cc_cache_match - Find a credential cache with a specified client principal.<a class="headerlink" href="#krb5-cc-cache-match-find-a-credential-cache-with-a-specified-client-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_cache_match"> -<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_cc_cache_match</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_cache_match" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_cache_match"> +<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_cc_cache_match</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cache_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_cache_match" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>client</strong> - Client principal</p> -<p class="last"><strong>[out]</strong> <strong>cache_out</strong> - Credential cache handle</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</li> -<li>KRB5_CC_NOTFOUND None</li> +<p><strong>[out]</strong> <strong>cache_out</strong> - Credential cache handle</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</p></li> +<li><p>KRB5_CC_NOTFOUND None</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Find a cache within the collection whose default principal is <em>client</em> . Use <em>krb5_cc_close</em> to close <em>ccache</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_cc_cache_match - Find a credential cache with a specified client principal.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_close.html b/doc/html/appdev/refs/api/krb5_cc_close.html index 3834cdf8c50b..66b7fb2c453d 100644 --- a/doc/html/appdev/refs/api/krb5_cc_close.html +++ b/doc/html/appdev/refs/api/krb5_cc_close.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_cc_close - Close a credential cache handle. — 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_cc_default - Resolve the default credential cache name." href="krb5_cc_default.html" /> <link rel="prev" title="krb5_build_principal_ext - Build a principal name using length-counted strings." href="krb5_build_principal_ext.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-close-close-a-credential-cache-handle"> + <section id="krb5-cc-close-close-a-credential-cache-handle"> <h1>krb5_cc_close - Close a credential cache handle.<a class="headerlink" href="#krb5-cc-close-close-a-credential-cache-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_close"> -<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_cc_close</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_close" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_close"> +<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_cc_close</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_close" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cache</strong> - Credential cache handle</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 simple"> -<li>0 Success</li> +<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>cache</strong> - Credential cache handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function closes a credential cache handle <em>cache</em> without affecting the contents of the cache.</p> -</div> +</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_cc_close - Close a credential cache handle.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_copy_creds.html b/doc/html/appdev/refs/api/krb5_cc_copy_creds.html index 9aea402ae00c..d5e2b462e3c0 100644 --- a/doc/html/appdev/refs/api/krb5_cc_copy_creds.html +++ b/doc/html/appdev/refs/api/krb5_cc_copy_creds.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_cc_copy_creds - Copy a credential cache. — 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_cc_end_seq_get - Finish a series of sequential processing credential cache entries." href="krb5_cc_end_seq_get.html" /> <link rel="prev" title="krb5_cc_cache_match - Find a credential cache with a specified client principal." href="krb5_cc_cache_match.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-copy-creds-copy-a-credential-cache"> + <section id="krb5-cc-copy-creds-copy-a-credential-cache"> <h1>krb5_cc_copy_creds - Copy a credential cache.<a class="headerlink" href="#krb5-cc-copy-creds-copy-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_copy_creds"> -<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_cc_copy_creds</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> incc</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> outcc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_copy_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_copy_creds"> +<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_cc_copy_creds</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">incc</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">outcc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_copy_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>incc</strong> - Credential cache to be copied</p> -<p class="last"><strong>[out]</strong> <strong>outcc</strong> - Copy of credential cache to be filled in</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>outcc</strong> - Copy of credential cache to be filled in</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> -</div> +</dd> +</dl> +</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_cc_copy_creds - Copy a credential cache.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_default.html b/doc/html/appdev/refs/api/krb5_cc_default.html index bd2ce381324d..15fa748ba7c5 100644 --- a/doc/html/appdev/refs/api/krb5_cc_default.html +++ b/doc/html/appdev/refs/api/krb5_cc_default.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_cc_default - Resolve the default credential cache name. — 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_cc_default_name - Return the name of the default credential cache." href="krb5_cc_default_name.html" /> <link rel="prev" title="krb5_cc_close - Close a credential cache handle." href="krb5_cc_close.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-default-resolve-the-default-credential-cache-name"> + <section id="krb5-cc-default-resolve-the-default-credential-cache-name"> <h1>krb5_cc_default - Resolve the default credential cache name.<a class="headerlink" href="#krb5-cc-default-resolve-the-default-credential-cache-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_default"> -<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_cc_default</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> ccache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_default"> +<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_cc_default</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ccache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>ccache</strong> - Pointer to credential cache name</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 simple"> -<li>0 Success</li> -<li>KV5M_CONTEXT Bad magic number for _krb5_context structure</li> -<li>KRB5_FCC_INTERNAL The name of the default credential cache cannot be obtained</li> +<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>[out]</strong> <strong>ccache</strong> - Pointer to credential cache name</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</p></li> +<li><p>KV5M_CONTEXT Bad magic number for _krb5_context structure</p></li> +<li><p>KRB5_FCC_INTERNAL The name of the default credential cache cannot be obtained</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Create a handle to the default credential cache as given by <a class="reference internal" href="krb5_cc_default_name.html#c.krb5_cc_default_name" title="krb5_cc_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_default_name()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>Create a handle to the default credential cache as given by krb5_cc_default_name().</p> +</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_cc_default - Resolve the default credential cache name.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_default_name.html b/doc/html/appdev/refs/api/krb5_cc_default_name.html index 705a42455905..eda52320090b 100644 --- a/doc/html/appdev/refs/api/krb5_cc_default_name.html +++ b/doc/html/appdev/refs/api/krb5_cc_default_name.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_cc_default_name - Return the name of the default credential cache. — 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_cc_destroy - Destroy a credential cache." href="krb5_cc_destroy.html" /> <link rel="prev" title="krb5_cc_default - Resolve the default credential cache name." href="krb5_cc_default.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-default-name-return-the-name-of-the-default-credential-cache"> + <section id="krb5-cc-default-name-return-the-name-of-the-default-credential-cache"> <h1>krb5_cc_default_name - Return the name of the default credential cache.<a class="headerlink" href="#krb5-cc-default-name-return-the-name-of-the-default-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_default_name"> -const char * <code class="descname">krb5_cc_default_name</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_default_name"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_cc_default_name</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="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_default_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>context</strong> - Library context</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>Name of default credential cache for the current user.</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>Name of default credential cache for the current user.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Return a pointer to the default credential cache name for <em>context</em> , as determined by a prior call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> , by the KRB5CCNAME environment variable, by the default_ccache_name profile variable, or by the operating system or build-time default value. The returned value must not be modified or freed by the caller. The returned value becomes invalid when <em>context</em> is destroyed <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></code></a> or if a subsequent call to <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> is made on <em>context</em> .</p> -<p>The default credential cache name is cached in <em>context</em> between calls to this function, so if the value of KRB5CCNAME changes in the process environment after the first call to this function on, that change will not be reflected in later calls with the same context. The caller can invoke <a class="reference internal" href="krb5_cc_set_default_name.html#c.krb5_cc_set_default_name" title="krb5_cc_set_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_set_default_name()</span></code></a> with a NULL value of <em>name</em> to clear the cached value and force the default name to be recomputed.</p> -</div> +</dd> +</dl> +<p>Return a pointer to the default credential cache name for <em>context</em> , as determined by a prior call to krb5_cc_set_default_name(), by the KRB5CCNAME environment variable, by the default_ccache_name profile variable, or by the operating system or build-time default value. The returned value must not be modified or freed by the caller. The returned value becomes invalid when <em>context</em> is destroyed krb5_free_context() or if a subsequent call to krb5_cc_set_default_name() is made on <em>context</em> .</p> +<p>The default credential cache name is cached in <em>context</em> between calls to this function, so if the value of KRB5CCNAME changes in the process environment after the first call to this function on, that change will not be reflected in later calls with the same context. The caller can invoke krb5_cc_set_default_name() with a NULL value of <em>name</em> to clear the cached value and force the default name to be recomputed.</p> +</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_cc_default_name - Return the name of the default credential cache.</a></li> @@ -140,6 +126,7 @@ const char * <code class="descname">krb5_cc_default_name</code><span class="sig- <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +134,8 @@ const char * <code class="descname">krb5_cc_default_name</code><span class="sig- <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_destroy.html b/doc/html/appdev/refs/api/krb5_cc_destroy.html index 6744b1a72b68..016e269009c8 100644 --- a/doc/html/appdev/refs/api/krb5_cc_destroy.html +++ b/doc/html/appdev/refs/api/krb5_cc_destroy.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_cc_destroy - Destroy a credential cache. — 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_cc_dup - Duplicate ccache handle." href="krb5_cc_dup.html" /> <link rel="prev" title="krb5_cc_default_name - Return the name of the default credential cache." href="krb5_cc_default_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-destroy-destroy-a-credential-cache"> + <section id="krb5-cc-destroy-destroy-a-credential-cache"> <h1>krb5_cc_destroy - Destroy a credential cache.<a class="headerlink" href="#krb5-cc-destroy-destroy-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_destroy"> -<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_cc_destroy</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_destroy" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_destroy"> +<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_cc_destroy</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_destroy" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cache</strong> - Credential cache handle</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 simple"> -<li>0 Success</li> +<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>cache</strong> - Credential cache handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Permission errors</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Permission errors</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function destroys any existing contents of <em>cache</em> and closes the handle to it.</p> -</div> +</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_cc_destroy - Destroy a credential cache.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_dup.html b/doc/html/appdev/refs/api/krb5_cc_dup.html index 13291baa4146..028e294b6533 100644 --- a/doc/html/appdev/refs/api/krb5_cc_dup.html +++ b/doc/html/appdev/refs/api/krb5_cc_dup.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_cc_dup - Duplicate ccache handle. — 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_cc_get_name - Retrieve the name, but not type of a credential cache." href="krb5_cc_get_name.html" /> <link rel="prev" title="krb5_cc_destroy - Destroy a credential cache." href="krb5_cc_destroy.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-dup-duplicate-ccache-handle"> + <section id="krb5-cc-dup-duplicate-ccache-handle"> <h1>krb5_cc_dup - Duplicate ccache handle.<a class="headerlink" href="#krb5-cc-dup-duplicate-ccache-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_dup"> -<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_cc_dup</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> in</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_dup" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_dup"> +<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_cc_dup</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">in</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_dup" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>in</strong> - Credential cache handle to be duplicated</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - Credential cache handle</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>out</strong> - Credential cache handle</p> +</dd> +</dl> <p>Create a new handle referring to the same cache as <em>in</em> . The new handle and <em>in</em> can be closed independently.</p> -</div> +</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_cc_dup - Duplicate ccache handle.</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_end_seq_get.html b/doc/html/appdev/refs/api/krb5_cc_end_seq_get.html index da54315aaf8e..fd6fee3def81 100644 --- a/doc/html/appdev/refs/api/krb5_cc_end_seq_get.html +++ b/doc/html/appdev/refs/api/krb5_cc_end_seq_get.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_cc_end_seq_get - Finish a series of sequential processing credential cache entries. — 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_cc_get_config - Get a configuration value from a credential cache." href="krb5_cc_get_config.html" /> <link rel="prev" title="krb5_cc_copy_creds - Copy a credential cache." href="krb5_cc_copy_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-end-seq-get-finish-a-series-of-sequential-processing-credential-cache-entries"> + <section id="krb5-cc-end-seq-get-finish-a-series-of-sequential-processing-credential-cache-entries"> <h1>krb5_cc_end_seq_get - Finish a series of sequential processing credential cache entries.<a class="headerlink" href="#krb5-cc-end-seq-get-finish-a-series-of-sequential-processing-credential-cache-entries" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_end_seq_get"> -<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_cc_end_seq_get</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor">krb5_cc_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_end_seq_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_end_seq_get"> +<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_cc_end_seq_get</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor"><span class="n"><span class="pre">krb5_cc_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_end_seq_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[in]</strong> <strong>cursor</strong> - Cursor</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 (always)</li> +<p><strong>[in]</strong> <strong>cursor</strong> - Cursor</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 (always)</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function finishes processing credential cache entries and invalidates <em>cursor</em> .</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_cc_start_seq_get.html#c.krb5_cc_start_seq_get" title="krb5_cc_start_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_start_seq_get()</span></code></a> , <a class="reference internal" href="krb5_cc_next_cred.html#c.krb5_cc_next_cred" title="krb5_cc_next_cred"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_next_cred()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_cc_start_seq_get(), krb5_cc_next_cred()</p> </div> +</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_cc_end_seq_get - Finish a series of sequential processing credential cache entries.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_gen_new.html b/doc/html/appdev/refs/api/krb5_cc_gen_new.html index 63a75bb13a5e..7ff44dc2f9e6 100644 --- a/doc/html/appdev/refs/api/krb5_cc_gen_new.html +++ b/doc/html/appdev/refs/api/krb5_cc_gen_new.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_cc_gen_new — 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_get_credentials_renew" href="krb5_get_credentials_renew.html" /> <link rel="prev" title="krb5_finish_random_key" href="krb5_finish_random_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-gen-new"> + <section id="krb5-cc-gen-new"> <h1>krb5_cc_gen_new<a class="headerlink" href="#krb5-cc-gen-new" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_gen_new"> -<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_cc_gen_new</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_gen_new" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_gen_new"> +<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_cc_gen_new</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_gen_new" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>cache</strong></p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>cache</strong></p> +</dd> +</dl> +</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_cc_gen_new</a></li> @@ -129,6 +118,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_config.html b/doc/html/appdev/refs/api/krb5_cc_get_config.html index 87ebb6f166ad..c0bb4ceac95e 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_config.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_config.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_cc_get_config - Get a configuration value from a credential cache. — 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_cc_get_flags - Retrieve flags from a credential cache structure." href="krb5_cc_get_flags.html" /> <link rel="prev" title="krb5_cc_end_seq_get - Finish a series of sequential processing credential cache entries." href="krb5_cc_end_seq_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-config-get-a-configuration-value-from-a-credential-cache"> + <section id="krb5-cc-get-config-get-a-configuration-value-from-a-credential-cache"> <h1>krb5_cc_get_config - Get a configuration value from a credential cache.<a class="headerlink" href="#krb5-cc-get-config-get-a-configuration-value-from-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_config"> -<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_cc_get_config</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> id</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const char *<em> key</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_config" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_config"> +<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_cc_get_config</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">id</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><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_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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_config" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>id</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>principal</strong> - Configuration for this principal; if NULL, global for the whole cache</p> <p><strong>[in]</strong> <strong>key</strong> - Name of config variable</p> -<p class="last"><strong>[out]</strong> <strong>data</strong> - Data to be fetched</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>data</strong> - Data to be fetched</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>data</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_data_contents() to free <em>data</em> when it is no longer needed.</p> +</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_cc_get_config - Get a configuration value from a credential cache.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_flags.html b/doc/html/appdev/refs/api/krb5_cc_get_flags.html index fde9025943a6..708f965aef19 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_flags.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_flags.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_cc_get_flags - Retrieve flags from a credential cache structure. — 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_cc_get_full_name - Retrieve the full name of a credential cache." href="krb5_cc_get_full_name.html" /> <link rel="prev" title="krb5_cc_get_config - Get a configuration value from a credential cache." href="krb5_cc_get_config.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-flags-retrieve-flags-from-a-credential-cache-structure"> + <section id="krb5-cc-get-flags-retrieve-flags-from-a-credential-cache-structure"> <h1>krb5_cc_get_flags - Retrieve flags from a credential cache structure.<a class="headerlink" href="#krb5-cc-get-flags-retrieve-flags-from-a-credential-cache-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_flags"> -<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_cc_get_flags</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a> *<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_flags"> +<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_cc_get_flags</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[out]</strong> <strong>flags</strong> - Flag bit mask</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>flags</strong> - Flag bit mask</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> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">For memory credential cache always returns a flag mask of 0.</p> -</div> +<p class="admonition-title">Warning</p> +<p>For memory credential cache always returns a flag mask of 0.</p> </div> +</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_cc_get_flags - Retrieve flags from a credential cache structure.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_full_name.html b/doc/html/appdev/refs/api/krb5_cc_get_full_name.html index 79d12c39f55e..5a10794bfd76 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_full_name.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_full_name.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_cc_get_full_name - Retrieve the full name of a credential cache. — 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_cc_move - Move a credential cache." href="krb5_cc_move.html" /> <link rel="prev" title="krb5_cc_get_flags - Retrieve flags from a credential cache structure." href="krb5_cc_get_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-full-name-retrieve-the-full-name-of-a-credential-cache"> + <section id="krb5-cc-get-full-name-retrieve-the-full-name-of-a-credential-cache"> <h1>krb5_cc_get_full_name - Retrieve the full name of a credential cache.<a class="headerlink" href="#krb5-cc-get-full-name-retrieve-the-full-name-of-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_full_name"> -<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_cc_get_full_name</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, char **<em> fullname_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_full_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_full_name"> +<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_cc_get_full_name</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fullname_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_full_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[out]</strong> <strong>fullname_out</strong> - Full name of cache</p> -</td> -</tr> -</tbody> -</table> -<p>Use <a class="reference internal" href="krb5_free_string.html#c.krb5_free_string" title="krb5_free_string"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_string()</span></code></a> to free <em>fullname_out</em> when it is no longer needed.</p> +<p><strong>[out]</strong> <strong>fullname_out</strong> - Full name of cache</p> +</dd> +</dl> +<p>Use krb5_free_string() to free <em>fullname_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_cc_get_full_name - Retrieve the full name of a credential cache.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_name.html b/doc/html/appdev/refs/api/krb5_cc_get_name.html index 529b54a0bfd8..01eb9aa17120 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_name.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_name.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_cc_get_name - Retrieve the name, but not type of a credential cache. — 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_cc_get_principal - Get the default principal of a credential cache." href="krb5_cc_get_principal.html" /> <link rel="prev" title="krb5_cc_dup - Duplicate ccache handle." href="krb5_cc_dup.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-name-retrieve-the-name-but-not-type-of-a-credential-cache"> + <section id="krb5-cc-get-name-retrieve-the-name-but-not-type-of-a-credential-cache"> <h1>krb5_cc_get_name - Retrieve the name, but not type of a credential cache.<a class="headerlink" href="#krb5-cc-get-name-retrieve-the-name-but-not-type-of-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_name"> -const char * <code class="descname">krb5_cc_get_name</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_name"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_cc_get_name</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cache</strong> - Credential cache handle</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>On success - the name of the credential cache.</li> +<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>cache</strong> - Credential cache handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>On success - the name of the credential cache.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">Returns the name of the credential cache. The result is an alias into <em>cache</em> and should not be freed or modified by the caller. This name does not include the cache type, so should not be used as input to <a class="reference internal" href="krb5_cc_resolve.html#c.krb5_cc_resolve" title="krb5_cc_resolve"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_resolve()</span></code></a> .</p> -</div> +<p class="admonition-title">Warning</p> +<p>Returns the name of the credential cache. The result is an alias into <em>cache</em> and should not be freed or modified by the caller. This name does not include the cache type, so should not be used as input to krb5_cc_resolve().</p> </div> +</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_cc_get_name - Retrieve the name, but not type of a credential cache.</a></li> @@ -144,6 +129,7 @@ const char * <code class="descname">krb5_cc_get_name</code><span class="sig-pare <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ const char * <code class="descname">krb5_cc_get_name</code><span class="sig-pare <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_principal.html b/doc/html/appdev/refs/api/krb5_cc_get_principal.html index 528eb67795f8..d0ad967e61f6 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_principal.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_principal.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_cc_get_principal - Get the default principal of a credential cache. — 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_cc_get_type - Retrieve the type of a credential cache." href="krb5_cc_get_type.html" /> <link rel="prev" title="krb5_cc_get_name - Retrieve the name, but not type of a credential cache." href="krb5_cc_get_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-principal-get-the-default-principal-of-a-credential-cache"> + <section id="krb5-cc-get-principal-get-the-default-principal-of-a-credential-cache"> <h1>krb5_cc_get_principal - Get the default principal of a credential cache.<a class="headerlink" href="#krb5-cc-get-principal-get-the-default-principal-of-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_principal"> -<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_cc_get_principal</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> principal</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_principal"> +<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_cc_get_principal</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">principal</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[out]</strong> <strong>principal</strong> - Primary principal</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>principal</strong> - Primary principal</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Returns the default client principal of a credential cache as set by <a class="reference internal" href="krb5_cc_initialize.html#c.krb5_cc_initialize" title="krb5_cc_initialize"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_initialize()</span></code></a> .</p> -<p>Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>principal</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Returns the default client principal of a credential cache as set by krb5_cc_initialize().</p> +<p>Use krb5_free_principal() to free <em>principal</em> when it is no longer needed.</p> +</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_cc_get_principal - Get the default principal of a credential cache.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_get_type.html b/doc/html/appdev/refs/api/krb5_cc_get_type.html index 83804d2f961f..e97c529be457 100644 --- a/doc/html/appdev/refs/api/krb5_cc_get_type.html +++ b/doc/html/appdev/refs/api/krb5_cc_get_type.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_cc_get_type - Retrieve the type of a credential cache. — 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_cc_initialize - Initialize a credential cache." href="krb5_cc_initialize.html" /> <link rel="prev" title="krb5_cc_get_principal - Get the default principal of a credential cache." href="krb5_cc_get_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-get-type-retrieve-the-type-of-a-credential-cache"> + <section id="krb5-cc-get-type-retrieve-the-type-of-a-credential-cache"> <h1>krb5_cc_get_type - Retrieve the type of a credential cache.<a class="headerlink" href="#krb5-cc-get-type-retrieve-the-type-of-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_get_type"> -const char * <code class="descname">krb5_cc_get_type</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_type" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_get_type"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_cc_get_type</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_get_type" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cache</strong> - Credential cache handle</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>The type of a credential cache as an alias that must not be modified or freed by the caller.</li> +<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>cache</strong> - Credential cache handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>The type of a credential cache as an alias that must not be modified or freed by the caller.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_cc_get_type - Retrieve the type of a credential cache.</a></li> @@ -140,6 +125,7 @@ const char * <code class="descname">krb5_cc_get_type</code><span class="sig-pare <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ const char * <code class="descname">krb5_cc_get_type</code><span class="sig-pare <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_initialize.html b/doc/html/appdev/refs/api/krb5_cc_initialize.html index 755214024d91..0d98dee30df8 100644 --- a/doc/html/appdev/refs/api/krb5_cc_initialize.html +++ b/doc/html/appdev/refs/api/krb5_cc_initialize.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_cc_initialize - Initialize a credential cache. — 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_cc_new_unique - Create a new credential cache of the specified type with a unique name." href="krb5_cc_new_unique.html" /> <link rel="prev" title="krb5_cc_get_type - Retrieve the type of a credential cache." href="krb5_cc_get_type.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-initialize-initialize-a-credential-cache"> + <section id="krb5-cc-initialize-initialize-a-credential-cache"> <h1>krb5_cc_initialize - Initialize a credential cache.<a class="headerlink" href="#krb5-cc-initialize-initialize-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_initialize"> -<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_cc_initialize</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> principal</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_initialize" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_initialize"> +<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_cc_initialize</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_initialize" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[in]</strong> <strong>principal</strong> - Default principal name</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>principal</strong> - Default principal name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>System errors; Permission errors; Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>System errors; Permission errors; Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Destroy any existing contents of <em>cache</em> and initialize it for the default principal <em>principal</em> .</p> -</div> +</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_cc_initialize - Initialize a credential cache.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_move.html b/doc/html/appdev/refs/api/krb5_cc_move.html index 2f0a7d0b7d20..2c474cb87cbf 100644 --- a/doc/html/appdev/refs/api/krb5_cc_move.html +++ b/doc/html/appdev/refs/api/krb5_cc_move.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_cc_move - Move a credential cache. — 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_cc_next_cred - Retrieve the next entry from the credential cache." href="krb5_cc_next_cred.html" /> <link rel="prev" title="krb5_cc_get_full_name - Retrieve the full name of a credential cache." href="krb5_cc_get_full_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-move-move-a-credential-cache"> + <section id="krb5-cc-move-move-a-credential-cache"> <h1>krb5_cc_move - Move a credential cache.<a class="headerlink" href="#krb5-cc-move-move-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_move"> -<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_cc_move</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> src</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> dst</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_move" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_move"> +<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_cc_move</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">src</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">dst</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_move" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>src</strong> - The credential cache to move the content from</p> -<p class="last"><strong>[in]</strong> <strong>dst</strong> - The credential cache to move the content to</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 simple"> -<li>0 Success; src is closed.</li> +<p><strong>[in]</strong> <strong>dst</strong> - The credential cache to move the content to</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; src is closed.</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes; src is still allocated.</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes; src is still allocated.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function reinitializes <em>dst</em> and populates it with the credentials and default principal of <em>src</em> ; then, if successful, destroys <em>src</em> .</p> -</div> +</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_cc_move - Move a credential cache.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_new_unique.html b/doc/html/appdev/refs/api/krb5_cc_new_unique.html index 8eac9e4fa960..7f116e875829 100644 --- a/doc/html/appdev/refs/api/krb5_cc_new_unique.html +++ b/doc/html/appdev/refs/api/krb5_cc_new_unique.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_cc_new_unique - Create a new credential cache of the specified type with a unique name. — 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_cc_resolve - Resolve a credential cache name." href="krb5_cc_resolve.html" /> <link rel="prev" title="krb5_cc_initialize - Initialize a credential cache." href="krb5_cc_initialize.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-new-unique-create-a-new-credential-cache-of-the-specified-type-with-a-unique-name"> + <section id="krb5-cc-new-unique-create-a-new-credential-cache-of-the-specified-type-with-a-unique-name"> <h1>krb5_cc_new_unique - Create a new credential cache of the specified type with a unique name.<a class="headerlink" href="#krb5-cc-new-unique-create-a-new-credential-cache-of-the-specified-type-with-a-unique-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_new_unique"> -<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_cc_new_unique</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 char *<em> type</em>, const char *<em> hint</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> id</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_new_unique" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_new_unique"> +<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_cc_new_unique</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">type</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">hint</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">id</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_new_unique" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>type</strong> - Credential cache type name</p> <p><strong>[in]</strong> <strong>hint</strong> - Unused</p> -<p class="last"><strong>[out]</strong> <strong>id</strong> - Credential cache handle</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>id</strong> - Credential cache handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_cc_new_unique - Create a new credential cache of the specified type with a unique name.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_next_cred.html b/doc/html/appdev/refs/api/krb5_cc_next_cred.html index 02fbb10a95cf..0430d9c19834 100644 --- a/doc/html/appdev/refs/api/krb5_cc_next_cred.html +++ b/doc/html/appdev/refs/api/krb5_cc_next_cred.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_cc_next_cred - Retrieve the next entry from the credential cache. — 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_cc_remove_cred - Remove credentials from a credential cache." href="krb5_cc_remove_cred.html" /> <link rel="prev" title="krb5_cc_move - Move a credential cache." href="krb5_cc_move.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-next-cred-retrieve-the-next-entry-from-the-credential-cache"> + <section id="krb5-cc-next-cred-retrieve-the-next-entry-from-the-credential-cache"> <h1>krb5_cc_next_cred - Retrieve the next entry from the credential cache.<a class="headerlink" href="#krb5-cc-next-cred-retrieve-the-next-entry-from-the-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_next_cred"> -<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_cc_next_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor">krb5_cc_cursor</a> *<em> cursor</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_next_cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_next_cred"> +<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_cc_next_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor"><span class="n"><span class="pre">krb5_cc_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_next_cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>cursor</strong> - Cursor</p> -<p class="last"><strong>[out]</strong> <strong>creds</strong> - Next credential cache entry</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>creds</strong> - Next credential cache entry</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 fills in <em>creds</em> with the next entry in <em>cache</em> and advances <em>cursor</em> .</p> -<p>Use <a class="reference internal" href="krb5_free_cred_contents.html#c.krb5_free_cred_contents" title="krb5_free_cred_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_cred_contents()</span></code></a> to free <em>creds</em> when it is no longer needed.</p> +<p>Use krb5_free_cred_contents() to free <em>creds</em> when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_cc_start_seq_get.html#c.krb5_cc_start_seq_get" title="krb5_cc_start_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_start_seq_get()</span></code></a> , krb5_end_seq_get()</p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_cc_start_seq_get(), krb5_end_seq_get()</p> </div> +</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_cc_next_cred - Retrieve the next entry from the credential cache.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_remove_cred.html b/doc/html/appdev/refs/api/krb5_cc_remove_cred.html index 26d08b41ba43..552b6d68d50a 100644 --- a/doc/html/appdev/refs/api/krb5_cc_remove_cred.html +++ b/doc/html/appdev/refs/api/krb5_cc_remove_cred.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_cc_remove_cred - Remove credentials from a credential cache. — 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_cc_retrieve_cred - Retrieve a specified credentials from a credential cache." href="krb5_cc_retrieve_cred.html" /> <link rel="prev" title="krb5_cc_next_cred - Retrieve the next entry from the credential cache." href="krb5_cc_next_cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-remove-cred-remove-credentials-from-a-credential-cache"> + <section id="krb5-cc-remove-cred-remove-credentials-from-a-credential-cache"> <h1>krb5_cc_remove_cred - Remove credentials from a credential cache.<a class="headerlink" href="#krb5-cc-remove-cred-remove-credentials-from-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_remove_cred"> -<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_cc_remove_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> flags</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_remove_cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_remove_cred"> +<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_cc_remove_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_remove_cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>flags</strong> - Bitwise-ORed search flags</p> -<p class="last"><strong>[in]</strong> <strong>creds</strong> - Credentials to be matched</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 simple"> -<li>KRB5_CC_NOSUPP Not implemented for this cache type</li> +<p><strong>[in]</strong> <strong>creds</strong> - Credentials to be matched</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>KRB5_CC_NOSUPP Not implemented for this cache type</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>No matches found; Data cannot be deleted; Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>No matches found; Data cannot be deleted; Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function accepts the same flag values as <a class="reference internal" href="krb5_cc_retrieve_cred.html#c.krb5_cc_retrieve_cred" title="krb5_cc_retrieve_cred"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_retrieve_cred()</span></code></a> .</p> +</dd> +</dl> +<p>This function accepts the same flag values as krb5_cc_retrieve_cred().</p> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">This function is not implemented for some cache types.</p> -</div> +<p class="admonition-title">Warning</p> +<p>This function is not implemented for some cache types.</p> </div> +</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_cc_remove_cred - Remove credentials from a credential cache.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_resolve.html b/doc/html/appdev/refs/api/krb5_cc_resolve.html index b9930e976f4c..4145693cf570 100644 --- a/doc/html/appdev/refs/api/krb5_cc_resolve.html +++ b/doc/html/appdev/refs/api/krb5_cc_resolve.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_cc_resolve - Resolve a credential cache name. — 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_change_password - Change a password for an existing Kerberos account." href="krb5_change_password.html" /> <link rel="prev" title="krb5_cc_new_unique - Create a new credential cache of the specified type with a unique name." href="krb5_cc_new_unique.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-resolve-resolve-a-credential-cache-name"> + <section id="krb5-cc-resolve-resolve-a-credential-cache-name"> <h1>krb5_cc_resolve - Resolve a credential cache name.<a class="headerlink" href="#krb5-cc-resolve-resolve-a-credential-cache-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_resolve"> -<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_cc_resolve</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 char *<em> name</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_resolve" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_resolve"> +<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_cc_resolve</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_resolve" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>name</strong> - Credential cache name to be resolved</p> -<p class="last"><strong>[out]</strong> <strong>cache</strong> - Credential cache handle</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>cache</strong> - Credential cache handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Fills in <em>cache</em> with a <em>cache</em> handle that corresponds to the name in <em>name</em> . <em>name</em> should be of the form <strong>type:residual</strong> , and <em>type</em> must be a type known to the library. If the <em>name</em> does not contain a colon, interpret it as a file name.</p> -</div> +</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_cc_resolve - Resolve a credential cache name.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_retrieve_cred.html b/doc/html/appdev/refs/api/krb5_cc_retrieve_cred.html index 4a99d4515496..ec432bc6a343 100644 --- a/doc/html/appdev/refs/api/krb5_cc_retrieve_cred.html +++ b/doc/html/appdev/refs/api/krb5_cc_retrieve_cred.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_cc_retrieve_cred - Retrieve a specified credentials from a credential cache. — 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_cc_select - Select a credential cache to use with a server principal." href="krb5_cc_select.html" /> <link rel="prev" title="krb5_cc_remove_cred - Remove credentials from a credential cache." href="krb5_cc_remove_cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,64 +52,58 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-retrieve-cred-retrieve-a-specified-credentials-from-a-credential-cache"> + <section id="krb5-cc-retrieve-cred-retrieve-a-specified-credentials-from-a-credential-cache"> <h1>krb5_cc_retrieve_cred - Retrieve a specified credentials from a credential cache.<a class="headerlink" href="#krb5-cc-retrieve-cred-retrieve-a-specified-credentials-from-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_retrieve_cred"> -<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_cc_retrieve_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> flags</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> mcreds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_retrieve_cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_retrieve_cred"> +<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_cc_retrieve_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">mcreds</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_retrieve_cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>flags</strong> - Flags bit mask</p> <p><strong>[in]</strong> <strong>mcreds</strong> - Credentials to match</p> -<p class="last"><strong>[out]</strong> <strong>creds</strong> - Credentials matching the requested value</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>creds</strong> - Credentials matching the requested value</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 searches a credential cache for credentials matching <em>mcreds</em> and returns it if found.</p> <p>Valid values for <em>flags</em> are:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_TIMES.html#KRB5_TC_MATCH_TIMES" title="KRB5_TC_MATCH_TIMES"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_TIMES</span></code></a> The requested lifetime must be at least as great as in <em>mcreds</em> .</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_IS_SKEY.html#KRB5_TC_MATCH_IS_SKEY" title="KRB5_TC_MATCH_IS_SKEY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_IS_SKEY</span></code></a> The <em>is_skey</em> field much match exactly.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_FLAGS.html#KRB5_TC_MATCH_FLAGS" title="KRB5_TC_MATCH_FLAGS"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_FLAGS</span></code></a> Flags set in <em>mcreds</em> must be set.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_TIMES_EXACT.html#KRB5_TC_MATCH_TIMES_EXACT" title="KRB5_TC_MATCH_TIMES_EXACT"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_TIMES_EXACT</span></code></a> The requested lifetime must match exactly.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_FLAGS_EXACT.html#KRB5_TC_MATCH_FLAGS_EXACT" title="KRB5_TC_MATCH_FLAGS_EXACT"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_FLAGS_EXACT</span></code></a> Flags must match exactly.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_AUTHDATA.html#KRB5_TC_MATCH_AUTHDATA" title="KRB5_TC_MATCH_AUTHDATA"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_AUTHDATA</span></code></a> The authorization data must match.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_SRV_NAMEONLY.html#KRB5_TC_MATCH_SRV_NAMEONLY" title="KRB5_TC_MATCH_SRV_NAMEONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_SRV_NAMEONLY</span></code></a> Only the name portion of the principal name must match, not the realm.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_2ND_TKT.html#KRB5_TC_MATCH_2ND_TKT" title="KRB5_TC_MATCH_2ND_TKT"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_2ND_TKT</span></code></a> The second tickets must match.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_MATCH_KTYPE.html#KRB5_TC_MATCH_KTYPE" title="KRB5_TC_MATCH_KTYPE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_MATCH_KTYPE</span></code></a> The encryption key types must match.</li> -<li><a class="reference internal" href="../macros/KRB5_TC_SUPPORTED_KTYPES.html#KRB5_TC_SUPPORTED_KTYPES" title="KRB5_TC_SUPPORTED_KTYPES"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TC_SUPPORTED_KTYPES</span></code></a> Check all matching entries that have any supported encryption type and return the one with the encryption type listed earliest.</li> +<li><p>#KRB5_TC_MATCH_TIMES The requested lifetime must be at least as great as in <em>mcreds</em> .</p></li> +<li><p>#KRB5_TC_MATCH_IS_SKEY The <em>is_skey</em> field much match exactly.</p></li> +<li><p>#KRB5_TC_MATCH_FLAGS Flags set in <em>mcreds</em> must be set.</p></li> +<li><p>#KRB5_TC_MATCH_TIMES_EXACT The requested lifetime must match exactly.</p></li> +<li><p>#KRB5_TC_MATCH_FLAGS_EXACT Flags must match exactly.</p></li> +<li><p>#KRB5_TC_MATCH_AUTHDATA The authorization data must match.</p></li> +<li><p>#KRB5_TC_MATCH_SRV_NAMEONLY Only the name portion of the principal name must match, not the realm.</p></li> +<li><p>#KRB5_TC_MATCH_2ND_TKT The second tickets must match.</p></li> +<li><p>#KRB5_TC_MATCH_KTYPE The encryption key types must match.</p></li> +<li><p>#KRB5_TC_SUPPORTED_KTYPES Check all matching entries that have any supported encryption type and return the one with the encryption type listed earliest.</p></li> </ul> </div></blockquote> -<p>Use <a class="reference internal" href="krb5_free_cred_contents.html#c.krb5_free_cred_contents" title="krb5_free_cred_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_cred_contents()</span></code></a> to free <em>creds</em> when it is no longer needed.</p> +<p>Use krb5_free_cred_contents() to free <em>creds</em> when it is no longer needed.</p> </div></blockquote> -</div> +</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_cc_retrieve_cred - Retrieve a specified credentials from a credential cache.</a></li> @@ -162,6 +147,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -169,8 +155,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_select.html b/doc/html/appdev/refs/api/krb5_cc_select.html index 0d1e12211ee9..e9fcc2c7ce7b 100644 --- a/doc/html/appdev/refs/api/krb5_cc_select.html +++ b/doc/html/appdev/refs/api/krb5_cc_select.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_cc_select - Select a credential cache to use with a server principal. — 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_cc_set_config - Store a configuration value in a credential cache." href="krb5_cc_set_config.html" /> <link rel="prev" title="krb5_cc_retrieve_cred - Retrieve a specified credentials from a credential cache." href="krb5_cc_retrieve_cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-select-select-a-credential-cache-to-use-with-a-server-principal"> + <section id="krb5-cc-select-select-a-credential-cache-to-use-with-a-server-principal"> <h1>krb5_cc_select - Select a credential cache to use with a server principal.<a class="headerlink" href="#krb5-cc-select-select-a-credential-cache-to-use-with-a-server-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_select"> -<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_cc_select</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> cache_out</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> princ_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_select" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_select"> +<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_cc_select</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cache_out</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princ_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_select" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>server</strong> - Server principal</p> <p><strong>[out]</strong> <strong>cache_out</strong> - Credential cache handle</p> -<p class="last"><strong>[out]</strong> <strong>princ_out</strong> - Client principal</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>If an appropriate cache is found, 0 is returned, cache_out is set to the selected cache, and princ_out is set to the default principal of that cache.</li> +<p><strong>[out]</strong> <strong>princ_out</strong> - Client principal</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>If an appropriate cache is found, 0 is returned, cache_out is set to the selected cache, and princ_out is set to the default principal of that cache.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Select a cache within the collection containing credentials most appropriate for use with <em>server</em> , according to configured rules and heuristics.</p> -<p>Use <a class="reference internal" href="krb5_cc_close.html#c.krb5_cc_close" title="krb5_cc_close"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_close()</span></code></a> to release <em>cache_out</em> when it is no longer needed. Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to release <em>princ_out</em> when it is no longer needed. Note that <em>princ_out</em> is set in some error conditions.</p> +<p>Use krb5_cc_close() to release <em>cache_out</em> when it is no longer needed. Use krb5_free_principal() to release <em>princ_out</em> when it is no longer needed. Note that <em>princ_out</em> is set in some error conditions.</p> <p>If the appropriate client principal can be authoritatively determined but the cache collection contains no credentials for that principal, then KRB5_CC_NOTFOUND is returned, <em>cache_out</em> is set to NULL, and <em>princ_out</em> is set to the appropriate client principal.</p> <p>If no configured mechanism can determine the appropriate cache or principal, KRB5_CC_NOTFOUND is returned and <em>cache_out</em> and <em>princ_out</em> are set to NULL.</p> <p>Any other error code indicates a fatal error in the processing of a cache selection mechanism.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_cc_select - Select a credential cache to use with a server principal.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_set_config.html b/doc/html/appdev/refs/api/krb5_cc_set_config.html index 0f929415782c..ef7220fc9a62 100644 --- a/doc/html/appdev/refs/api/krb5_cc_set_config.html +++ b/doc/html/appdev/refs/api/krb5_cc_set_config.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_cc_set_config - Store a configuration value in a credential cache. — 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_cc_set_default_name - Set the default credential cache name." href="krb5_cc_set_default_name.html" /> <link rel="prev" title="krb5_cc_select - Select a credential cache to use with a server principal." href="krb5_cc_select.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,58 +52,52 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-set-config-store-a-configuration-value-in-a-credential-cache"> + <section id="krb5-cc-set-config-store-a-configuration-value-in-a-credential-cache"> <h1>krb5_cc_set_config - Store a configuration value in a credential cache.<a class="headerlink" href="#krb5-cc-set-config-store-a-configuration-value-in-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_set_config"> -<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_cc_set_config</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> id</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const char *<em> key</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_config" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_set_config"> +<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_cc_set_config</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">id</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><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_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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_config" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>id</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>principal</strong> - Configuration for a specific principal; if NULL, global for the whole cache</p> <p><strong>[in]</strong> <strong>key</strong> - Name of config variable</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Data to store, or NULL to remove</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>data</strong> - Data to store, or NULL to remove</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">Before version 1.10 <em>data</em> was assumed to be always non-null.</p> +<p class="admonition-title">Warning</p> +<p>Before version 1.10 <em>data</em> was assumed to be always non-null.</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Existing configuration under the same key is over-written.</p> -</div> +<p class="admonition-title">Note</p> +<p>Existing configuration under the same key is over-written.</p> </div> +</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_cc_set_config - Store a configuration value in a credential cache.</a></li> @@ -156,6 +141,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -163,8 +149,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_set_default_name.html b/doc/html/appdev/refs/api/krb5_cc_set_default_name.html index e33bb387e643..b93293766b8e 100644 --- a/doc/html/appdev/refs/api/krb5_cc_set_default_name.html +++ b/doc/html/appdev/refs/api/krb5_cc_set_default_name.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_cc_set_default_name - Set the default credential cache name. — 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_cc_set_flags - Set options flags on a credential cache." href="krb5_cc_set_flags.html" /> <link rel="prev" title="krb5_cc_set_config - Store a configuration value in a credential cache." href="krb5_cc_set_config.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-set-default-name-set-the-default-credential-cache-name"> + <section id="krb5-cc-set-default-name-set-the-default-credential-cache-name"> <h1>krb5_cc_set_default_name - Set the default credential cache name.<a class="headerlink" href="#krb5-cc-set-default-name-set-the-default-credential-cache-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_set_default_name"> -<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_cc_set_default_name</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 char *<em> name</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_default_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_set_default_name"> +<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_cc_set_default_name</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_default_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>name</strong> - Default credential cache name or NULL</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 simple"> -<li>0 Success</li> -<li>KV5M_CONTEXT Bad magic number for _krb5_context structure</li> +<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>name</strong> - Default credential cache name or NULL</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</p></li> +<li><p>KV5M_CONTEXT Bad magic number for _krb5_context structure</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Set the default credential cache name to <em>name</em> for future operations using <em>context</em> . If <em>name</em> is NULL, clear any previous application-set default name and forget any cached value of the default name for <em>context</em> .</p> -<p>Calls to this function invalidate the result of any previous calls to <a class="reference internal" href="krb5_cc_default_name.html#c.krb5_cc_default_name" title="krb5_cc_default_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_default_name()</span></code></a> using <em>context</em> .</p> -</div> +<p>Calls to this function invalidate the result of any previous calls to krb5_cc_default_name() using <em>context</em> .</p> +</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_cc_set_default_name - Set the default credential cache name.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_set_flags.html b/doc/html/appdev/refs/api/krb5_cc_set_flags.html index c6d49133f0be..e6a95794822b 100644 --- a/doc/html/appdev/refs/api/krb5_cc_set_flags.html +++ b/doc/html/appdev/refs/api/krb5_cc_set_flags.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_cc_set_flags - Set options flags on a credential cache. — 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_cc_start_seq_get - Prepare to sequentially read every credential in a credential cache." href="krb5_cc_start_seq_get.html" /> <link rel="prev" title="krb5_cc_set_default_name - Set the default credential cache name." href="krb5_cc_set_default_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-set-flags-set-options-flags-on-a-credential-cache"> + <section id="krb5-cc-set-flags-set-options-flags-on-a-credential-cache"> <h1>krb5_cc_set_flags - Set options flags on a credential cache.<a class="headerlink" href="#krb5-cc-set-flags-set-options-flags-on-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_set_flags"> -<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_cc_set_flags</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_set_flags"> +<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_cc_set_flags</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_set_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[in]</strong> <strong>flags</strong> - Flag bit mask</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>flags</strong> - Flag bit mask</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 resets <em>cache</em> flags to <em>flags</em> .</p> -</div> +</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_cc_set_flags - Set options flags on a credential cache.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_start_seq_get.html b/doc/html/appdev/refs/api/krb5_cc_start_seq_get.html index f45f937ed585..d4d41c8fa61b 100644 --- a/doc/html/appdev/refs/api/krb5_cc_start_seq_get.html +++ b/doc/html/appdev/refs/api/krb5_cc_start_seq_get.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_cc_start_seq_get - Prepare to sequentially read every credential in a credential cache. — 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_cc_store_cred - Store credentials in a credential cache." href="krb5_cc_store_cred.html" /> <link rel="prev" title="krb5_cc_set_flags - Set options flags on a credential cache." href="krb5_cc_set_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-start-seq-get-prepare-to-sequentially-read-every-credential-in-a-credential-cache"> + <section id="krb5-cc-start-seq-get-prepare-to-sequentially-read-every-credential-in-a-credential-cache"> <h1>krb5_cc_start_seq_get - Prepare to sequentially read every credential in a credential cache.<a class="headerlink" href="#krb5-cc-start-seq-get-prepare-to-sequentially-read-every-credential-in-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_start_seq_get"> -<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_cc_start_seq_get</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor">krb5_cc_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_start_seq_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_start_seq_get"> +<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_cc_start_seq_get</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_cc_cursor.html#c.krb5_cc_cursor" title="krb5_cc_cursor"><span class="n"><span class="pre">krb5_cc_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_start_seq_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[out]</strong> <strong>cursor</strong> - Cursor</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>cursor</strong> - Cursor</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> -<blockquote> -<div><a class="reference internal" href="krb5_cc_end_seq_get.html#c.krb5_cc_end_seq_get" title="krb5_cc_end_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_end_seq_get()</span></code></a> must be called to complete the retrieve operation.</div></blockquote> +</dd> +</dl> +<p>krb5_cc_end_seq_get() must be called to complete the retrieve operation.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If the cache represented by <em>cache</em> is modified between the time of the call to this function and the time of the final <a class="reference internal" href="krb5_cc_end_seq_get.html#c.krb5_cc_end_seq_get" title="krb5_cc_end_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_end_seq_get()</span></code></a> , these changes may not be reflected in the results of <a class="reference internal" href="krb5_cc_next_cred.html#c.krb5_cc_next_cred" title="krb5_cc_next_cred"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_next_cred()</span></code></a> calls.</p> -</div> +<p class="admonition-title">Note</p> +<p>If the cache represented by <em>cache</em> is modified between the time of the call to this function and the time of the final krb5_cc_end_seq_get(), these changes may not be reflected in the results of krb5_cc_next_cred() calls.</p> </div> +</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_cc_start_seq_get - Prepare to sequentially read every credential in a credential cache.</a></li> @@ -147,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_store_cred.html b/doc/html/appdev/refs/api/krb5_cc_store_cred.html index 3ce10564ab7f..47bd1354ad41 100644 --- a/doc/html/appdev/refs/api/krb5_cc_store_cred.html +++ b/doc/html/appdev/refs/api/krb5_cc_store_cred.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_cc_store_cred - Store credentials in a credential cache. — 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_cc_support_switch - Determine whether a credential cache type supports switching." href="krb5_cc_support_switch.html" /> <link rel="prev" title="krb5_cc_start_seq_get - Prepare to sequentially read every credential in a credential cache." href="krb5_cc_start_seq_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-store-cred-store-credentials-in-a-credential-cache"> + <section id="krb5-cc-store-cred-store-credentials-in-a-credential-cache"> <h1>krb5_cc_store_cred - Store credentials in a credential cache.<a class="headerlink" href="#krb5-cc-store-cred-store-credentials-in-a-credential-cache" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_store_cred"> -<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_cc_store_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_store_cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_store_cred"> +<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_cc_store_cred</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_store_cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cache</strong> - Credential cache handle</p> -<p class="last"><strong>[in]</strong> <strong>creds</strong> - Credentials to be stored in cache</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>creds</strong> - Credentials to be stored in cache</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Permission errors; storage failure errors; Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Permission errors; storage failure errors; Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function stores <em>creds</em> into <em>cache</em> . If <em>creds->server</em> and the server in the decoded ticket <em>creds->ticket</em> differ, the credentials will be stored under both server principal names.</p> -</div> +</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_cc_store_cred - Store credentials in a credential cache.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_support_switch.html b/doc/html/appdev/refs/api/krb5_cc_support_switch.html index 7500204887ed..ae2078d29fa6 100644 --- a/doc/html/appdev/refs/api/krb5_cc_support_switch.html +++ b/doc/html/appdev/refs/api/krb5_cc_support_switch.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_cc_support_switch - Determine whether a credential cache type supports switching. — 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_cc_switch - Make a credential cache the primary cache for its collection." href="krb5_cc_switch.html" /> <link rel="prev" title="krb5_cc_store_cred - Store credentials in a credential cache." href="krb5_cc_store_cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-support-switch-determine-whether-a-credential-cache-type-supports-switching"> + <section id="krb5-cc-support-switch-determine-whether-a-credential-cache-type-supports-switching"> <h1>krb5_cc_support_switch - Determine whether a credential cache type supports switching.<a class="headerlink" href="#krb5-cc-support-switch-determine-whether-a-credential-cache-type-supports-switching" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_support_switch"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_cc_support_switch</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 char *<em> type</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_support_switch" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_support_switch"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_cc_support_switch</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">type</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_support_switch" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>type</strong> - Credential cache type</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>TRUE if type supports switching</li> -<li>FALSE if it does not or is not a valid credential cache type.</li> +<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>type</strong> - Credential cache type</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if type supports switching</p></li> +<li><p>FALSE if it does not or is not a valid credential cache type.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_cc_support_switch - Determine whether a credential cache type supports switching.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cc_switch.html b/doc/html/appdev/refs/api/krb5_cc_switch.html index 6fbcbc51f35b..a46731857e99 100644 --- a/doc/html/appdev/refs/api/krb5_cc_switch.html +++ b/doc/html/appdev/refs/api/krb5_cc_switch.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_cc_switch - Make a credential cache the primary cache for its collection. — 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_cccol_cursor_free - Free a credential cache collection cursor." href="krb5_cccol_cursor_free.html" /> <link rel="prev" title="krb5_cc_support_switch - Determine whether a credential cache type supports switching." href="krb5_cc_support_switch.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cc-switch-make-a-credential-cache-the-primary-cache-for-its-collection"> + <section id="krb5-cc-switch-make-a-credential-cache-the-primary-cache-for-its-collection"> <h1>krb5_cc_switch - Make a credential cache the primary cache for its collection.<a class="headerlink" href="#krb5-cc-switch-make-a-credential-cache-the-primary-cache-for-its-collection" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cc_switch"> -<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_cc_switch</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_switch" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cc_switch"> +<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_cc_switch</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cc_switch" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cache</strong> - Credential cache handle</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 simple"> -<li>0 Success, or the type of cache doesn’t support switching</li> +<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>cache</strong> - Credential cache handle</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, or the type of cache doesn’t support switching</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>If the type of <em>cache</em> supports it, set <em>cache</em> to be the primary credential cache for the collection it belongs to.</p> -</div> +</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_cc_switch - Make a credential cache the primary cache for its collection.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cccol_cursor_free.html b/doc/html/appdev/refs/api/krb5_cccol_cursor_free.html index 09ce5c4595be..6167b696e8d9 100644 --- a/doc/html/appdev/refs/api/krb5_cccol_cursor_free.html +++ b/doc/html/appdev/refs/api/krb5_cccol_cursor_free.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_cccol_cursor_free - Free a credential cache collection cursor. — 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_cccol_cursor_new - Prepare to iterate over the collection of known credential caches." href="krb5_cccol_cursor_new.html" /> <link rel="prev" title="krb5_cc_switch - Make a credential cache the primary cache for its collection." href="krb5_cc_switch.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cccol-cursor-free-free-a-credential-cache-collection-cursor"> + <section id="krb5-cccol-cursor-free-free-a-credential-cache-collection-cursor"> <h1>krb5_cccol_cursor_free - Free a credential cache collection cursor.<a class="headerlink" href="#krb5-cccol-cursor-free-free-a-credential-cache-collection-cursor" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cccol_cursor_free"> -<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_cccol_cursor_free</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor">krb5_cccol_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cccol_cursor_free"> +<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_cccol_cursor_free</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor"><span class="n"><span class="pre">krb5_cccol_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>cursor</strong> - Cursor</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> +<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>cursor</strong> - Cursor</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> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_cccol_cursor_new.html#c.krb5_cccol_cursor_new" title="krb5_cccol_cursor_new"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_new()</span></code></a> , <a class="reference internal" href="krb5_cccol_cursor_next.html#c.krb5_cccol_cursor_next" title="krb5_cccol_cursor_next"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_next()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_cccol_cursor_new(), krb5_cccol_cursor_next()</p> </div> +</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_cccol_cursor_free - Free a credential cache collection cursor.</a></li> @@ -144,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cccol_cursor_new.html b/doc/html/appdev/refs/api/krb5_cccol_cursor_new.html index ba02c0fcf520..ffbb6d3e3178 100644 --- a/doc/html/appdev/refs/api/krb5_cccol_cursor_new.html +++ b/doc/html/appdev/refs/api/krb5_cccol_cursor_new.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_cccol_cursor_new - Prepare to iterate over the collection of known credential caches. — 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_cccol_cursor_next - Get the next credential cache in the collection." href="krb5_cccol_cursor_next.html" /> <link rel="prev" title="krb5_cccol_cursor_free - Free a credential cache collection cursor." href="krb5_cccol_cursor_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cccol-cursor-new-prepare-to-iterate-over-the-collection-of-known-credential-caches"> + <section id="krb5-cccol-cursor-new-prepare-to-iterate-over-the-collection-of-known-credential-caches"> <h1>krb5_cccol_cursor_new - Prepare to iterate over the collection of known credential caches.<a class="headerlink" href="#krb5-cccol-cursor-new-prepare-to-iterate-over-the-collection-of-known-credential-caches" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cccol_cursor_new"> -<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_cccol_cursor_new</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor">krb5_cccol_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_new" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cccol_cursor_new"> +<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_cccol_cursor_new</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor"><span class="n"><span class="pre">krb5_cccol_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_new" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>cursor</strong> - Cursor</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> +<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>[out]</strong> <strong>cursor</strong> - Cursor</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>Get a new cache iteration <em>cursor</em> that will iterate over all known credential caches independent of type.</p> -<p>Use <a class="reference internal" href="krb5_cccol_cursor_free.html#c.krb5_cccol_cursor_free" title="krb5_cccol_cursor_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_free()</span></code></a> to release <em>cursor</em> when it is no longer needed.</p> +<p>Use krb5_cccol_cursor_free() to release <em>cursor</em> when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_cccol_cursor_next.html#c.krb5_cccol_cursor_next" title="krb5_cccol_cursor_next"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_next()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_cccol_cursor_next()</p> </div> +</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_cccol_cursor_new - Prepare to iterate over the collection of known credential caches.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cccol_cursor_next.html b/doc/html/appdev/refs/api/krb5_cccol_cursor_next.html index 8aa7f2c457a0..79962cc2b4c5 100644 --- a/doc/html/appdev/refs/api/krb5_cccol_cursor_next.html +++ b/doc/html/appdev/refs/api/krb5_cccol_cursor_next.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_cccol_cursor_next - Get the next credential cache in the collection. — 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_cccol_have_content - Check if the credential cache collection contains any initialized caches." href="krb5_cccol_have_content.html" /> <link rel="prev" title="krb5_cccol_cursor_new - Prepare to iterate over the collection of known credential caches." href="krb5_cccol_cursor_new.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cccol-cursor-next-get-the-next-credential-cache-in-the-collection"> + <section id="krb5-cccol-cursor-next-get-the-next-credential-cache-in-the-collection"> <h1>krb5_cccol_cursor_next - Get the next credential cache in the collection.<a class="headerlink" href="#krb5-cccol-cursor-next-get-the-next-credential-cache-in-the-collection" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cccol_cursor_next"> -<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_cccol_cursor_next</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor">krb5_cccol_cursor</a><em> cursor</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> ccache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_next" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cccol_cursor_next"> +<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_cccol_cursor_next</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>, <a class="reference internal" href="../types/krb5_cccol_cursor.html#c.krb5_cccol_cursor" title="krb5_cccol_cursor"><span class="n"><span class="pre">krb5_cccol_cursor</span></span></a><span class="w"> </span><span class="n"><span class="pre">cursor</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ccache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_cursor_next" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cursor</strong> - Cursor</p> -<p class="last"><strong>[out]</strong> <strong>ccache</strong> - Credential cache handle</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>ccache</strong> - Credential cache handle</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> -<p>Use <a class="reference internal" href="krb5_cc_close.html#c.krb5_cc_close" title="krb5_cc_close"><code class="xref c c-func docutils literal"><span class="pre">krb5_cc_close()</span></code></a> to close <em>ccache</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Use krb5_cc_close() to close <em>ccache</em> when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_cccol_cursor_new.html#c.krb5_cccol_cursor_new" title="krb5_cccol_cursor_new"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_new()</span></code></a> , <a class="reference internal" href="krb5_cccol_cursor_free.html#c.krb5_cccol_cursor_free" title="krb5_cccol_cursor_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_cccol_cursor_free()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_cccol_cursor_new(), krb5_cccol_cursor_free()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">When all caches are iterated over and the end of the list is reached, <em>ccache</em> is set to NULL.</p> -</div> +<p class="admonition-title">Note</p> +<p>When all caches are iterated over and the end of the list is reached, <em>ccache</em> is set to NULL.</p> </div> +</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_cccol_cursor_next - Get the next credential cache in the collection.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cccol_have_content.html b/doc/html/appdev/refs/api/krb5_cccol_have_content.html index a48848235837..df061ced5abb 100644 --- a/doc/html/appdev/refs/api/krb5_cccol_have_content.html +++ b/doc/html/appdev/refs/api/krb5_cccol_have_content.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_cccol_have_content - Check if the credential cache collection contains any initialized caches. — 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_clear_error_message - Clear the extended error message in a context." href="krb5_clear_error_message.html" /> <link rel="prev" title="krb5_cccol_cursor_next - Get the next credential cache in the collection." href="krb5_cccol_cursor_next.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cccol-have-content-check-if-the-credential-cache-collection-contains-any-initialized-caches"> + <section id="krb5-cccol-have-content-check-if-the-credential-cache-collection-contains-any-initialized-caches"> <h1>krb5_cccol_have_content - Check if the credential cache collection contains any initialized caches.<a class="headerlink" href="#krb5-cccol-have-content-check-if-the-credential-cache-collection-contains-any-initialized-caches" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cccol_have_content"> -<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_cccol_have_content</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_have_content" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cccol_have_content"> +<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_cccol_have_content</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="sig-paren">)</span><a class="headerlink" href="#c.krb5_cccol_have_content" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>context</strong> - Library context</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 At least one initialized cache is present in the collection</li> -<li>KRB5_CC_NOTFOUND The collection contains no caches</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 At least one initialized cache is present in the collection</p></li> +<li><p>KRB5_CC_NOTFOUND The collection contains no caches</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_cccol_have_content - Check if the credential cache collection contains any initialized caches.</a></li> @@ -143,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_change_password.html b/doc/html/appdev/refs/api/krb5_change_password.html index 4e3dd22fb043..2be3e6c710c2 100644 --- a/doc/html/appdev/refs/api/krb5_change_password.html +++ b/doc/html/appdev/refs/api/krb5_change_password.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_change_password - Change a password for an existing Kerberos account. — 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_chpw_message - Get a result message for changing or setting a password." href="krb5_chpw_message.html" /> <link rel="prev" title="krb5_cc_resolve - Resolve a credential cache name." href="krb5_cc_resolve.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,57 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-change-password-change-a-password-for-an-existing-kerberos-account"> + <section id="krb5-change-password-change-a-password-for-an-existing-kerberos-account"> <h1>krb5_change_password - Change a password for an existing Kerberos account.<a class="headerlink" href="#krb5-change-password-change-a-password-for-an-existing-kerberos-account" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_change_password"> -<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_change_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, const char *<em> newpw</em>, int *<em> result_code</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_code_string</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_string</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_change_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_change_password"> +<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_change_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newpw</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result_code</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">result_code_string</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">result_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_change_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>creds</strong> - Credentials for kadmin/changepw service</p> <p><strong>[in]</strong> <strong>newpw</strong> - New password</p> <p><strong>[out]</strong> <strong>result_code</strong> - Numeric error code from server</p> <p><strong>[out]</strong> <strong>result_code_string</strong> - String equivalent to <em>result_code</em></p> -<p class="last"><strong>[out]</strong> <strong>result_string</strong> - Change password response from the KDC</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>result_string</strong> - Change password response from the KDC</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>Change the password for the existing principal identified by <em>creds</em> .</p> <p>The possible values of the output <em>result_code</em> are:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_KPASSWD_SUCCESS.html#KRB5_KPASSWD_SUCCESS" title="KRB5_KPASSWD_SUCCESS"><code class="xref py py-data docutils literal"><span class="pre">KRB5_KPASSWD_SUCCESS</span></code></a> (0) - success</li> -<li><a class="reference internal" href="../macros/KRB5_KPASSWD_MALFORMED.html#KRB5_KPASSWD_MALFORMED" title="KRB5_KPASSWD_MALFORMED"><code class="xref py py-data docutils literal"><span class="pre">KRB5_KPASSWD_MALFORMED</span></code></a> (1) - Malformed request error</li> -<li><a class="reference internal" href="../macros/KRB5_KPASSWD_HARDERROR.html#KRB5_KPASSWD_HARDERROR" title="KRB5_KPASSWD_HARDERROR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_KPASSWD_HARDERROR</span></code></a> (2) - Server error</li> -<li><a class="reference internal" href="../macros/KRB5_KPASSWD_AUTHERROR.html#KRB5_KPASSWD_AUTHERROR" title="KRB5_KPASSWD_AUTHERROR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_KPASSWD_AUTHERROR</span></code></a> (3) - Authentication error</li> -<li><a class="reference internal" href="../macros/KRB5_KPASSWD_SOFTERROR.html#KRB5_KPASSWD_SOFTERROR" title="KRB5_KPASSWD_SOFTERROR"><code class="xref py py-data docutils literal"><span class="pre">KRB5_KPASSWD_SOFTERROR</span></code></a> (4) - Password change rejected</li> +<li><p>#KRB5_KPASSWD_SUCCESS (0) - success</p></li> +<li><p>#KRB5_KPASSWD_MALFORMED (1) - Malformed request error</p></li> +<li><p>#KRB5_KPASSWD_HARDERROR (2) - Server error</p></li> +<li><p>#KRB5_KPASSWD_AUTHERROR (3) - Authentication error</p></li> +<li><p>#KRB5_KPASSWD_SOFTERROR (4) - Password change rejected</p></li> </ul> </div></blockquote> -</div> +</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_change_password - Change a password for an existing Kerberos account.</a></li> @@ -155,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -162,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_check_clockskew.html b/doc/html/appdev/refs/api/krb5_check_clockskew.html index 86ec2a20ba09..ab5896da175b 100644 --- a/doc/html/appdev/refs/api/krb5_check_clockskew.html +++ b/doc/html/appdev/refs/api/krb5_check_clockskew.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_check_clockskew - Check if a timestamp is within the allowed clock skew of the current time. — 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_copy_addresses - Copy an array of addresses." href="krb5_copy_addresses.html" /> <link rel="prev" title="krb5_clear_error_message - Clear the extended error message in a context." href="krb5_clear_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-check-clockskew-check-if-a-timestamp-is-within-the-allowed-clock-skew-of-the-current-time"> + <section id="krb5-check-clockskew-check-if-a-timestamp-is-within-the-allowed-clock-skew-of-the-current-time"> <h1>krb5_check_clockskew - Check if a timestamp is within the allowed clock skew of the current time.<a class="headerlink" href="#krb5-check-clockskew-check-if-a-timestamp-is-within-the-allowed-clock-skew-of-the-current-time" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_check_clockskew"> -<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_check_clockskew</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> date</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_check_clockskew" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_check_clockskew"> +<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_check_clockskew</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">date</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_check_clockskew" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>date</strong> - Timestamp to check</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</li> -<li>KRB5KRB_AP_ERR_SKEW date is not within allowable clock skew</li> +<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>date</strong> - Timestamp to check</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</p></li> +<li><p>KRB5KRB_AP_ERR_SKEW date is not within allowable clock skew</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function checks if <em>date</em> is close enough to the current time according to the configured allowable clock skew.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_check_clockskew - Check if a timestamp is within the allowed clock skew of the current time.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_checksum_size.html b/doc/html/appdev/refs/api/krb5_checksum_size.html index 3bd920b15a36..893ff4b8cea5 100644 --- a/doc/html/appdev/refs/api/krb5_checksum_size.html +++ b/doc/html/appdev/refs/api/krb5_checksum_size.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_checksum_size — 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_encrypt" href="krb5_encrypt.html" /> <link rel="prev" title="krb5_calculate_checksum" href="krb5_calculate_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-checksum-size"> + <section id="krb5-checksum-size"> <h1>krb5_checksum_size<a class="headerlink" href="#krb5-checksum-size" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_checksum_size"> -size_t <code class="descname">krb5_checksum_size</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_checksum_size" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_checksum_size"> +<span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_checksum_size</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_checksum_size" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>ctype</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>ctype</strong></p> +</dd> +</dl> <p>DEPRECATED See krb5_c_checksum_length()</p> -</div> +</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_checksum_size</a></li> @@ -130,6 +119,7 @@ size_t <code class="descname">krb5_checksum_size</code><span class="sig-paren">( <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ size_t <code class="descname">krb5_checksum_size</code><span class="sig-paren">( <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_chpw_message.html b/doc/html/appdev/refs/api/krb5_chpw_message.html index d49089b8c783..6a8ea88b23ff 100644 --- a/doc/html/appdev/refs/api/krb5_chpw_message.html +++ b/doc/html/appdev/refs/api/krb5_chpw_message.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_chpw_message - Get a result message for changing or setting a password. — 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_expand_hostname - Canonicalize a hostname, possibly using name service." href="krb5_expand_hostname.html" /> <link rel="prev" title="krb5_change_password - Change a password for an existing Kerberos account." href="krb5_change_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-chpw-message-get-a-result-message-for-changing-or-setting-a-password"> + <section id="krb5-chpw-message-get-a-result-message-for-changing-or-setting-a-password"> <h1>krb5_chpw_message - Get a result message for changing or setting a password.<a class="headerlink" href="#krb5-chpw-message-get-a-result-message-for-changing-or-setting-a-password" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_chpw_message"> -<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_chpw_message</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> server_string</em>, char **<em> message_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_chpw_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_chpw_message"> +<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_chpw_message</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_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">server_string</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">message_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_chpw_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>server_string</strong> - Data returned from the remote system</p> -<p class="last"><strong>[out]</strong> <strong>message_out</strong> - A message displayable to the user</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>message_out</strong> - A message displayable to the user</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function processes the <em>server_string</em> returned in the <em>result_string</em> parameter of <a class="reference internal" href="krb5_change_password.html#c.krb5_change_password" title="krb5_change_password"><code class="xref c c-func docutils literal"><span class="pre">krb5_change_password()</span></code></a> , <a class="reference internal" href="krb5_set_password.html#c.krb5_set_password" title="krb5_set_password"><code class="xref c c-func docutils literal"><span class="pre">krb5_set_password()</span></code></a> , and related functions, and returns a displayable string. If <em>server_string</em> contains Active Directory structured policy information, it will be converted into human-readable text.</p> -<p>Use <a class="reference internal" href="krb5_free_string.html#c.krb5_free_string" title="krb5_free_string"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_string()</span></code></a> to free <em>message_out</em> when it is no longer needed.</p> +</dd> +</dl> +<p>This function processes the <em>server_string</em> returned in the <em>result_string</em> parameter of krb5_change_password(), krb5_set_password(), and related functions, and returns a displayable string. If <em>server_string</em> contains Active Directory structured policy information, it will be converted into human-readable text.</p> +<p>Use krb5_free_string() to free <em>message_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_chpw_message - Get a result message for changing or setting a password.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_cksumtype_to_string.html b/doc/html/appdev/refs/api/krb5_cksumtype_to_string.html index df477a590985..0246b8be2c0a 100644 --- a/doc/html/appdev/refs/api/krb5_cksumtype_to_string.html +++ b/doc/html/appdev/refs/api/krb5_cksumtype_to_string.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_cksumtype_to_string - Convert a checksum type to a string. — 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_decode_authdata_container - Unwrap authorization data." href="krb5_decode_authdata_container.html" /> <link rel="prev" title="krb5_c_verify_checksum_iov - Validate a checksum element in IOV array (operates on keyblock)." href="krb5_c_verify_checksum_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-cksumtype-to-string-convert-a-checksum-type-to-a-string"> + <section id="krb5-cksumtype-to-string-convert-a-checksum-type-to-a-string"> <h1>krb5_cksumtype_to_string - Convert a checksum type to a string.<a class="headerlink" href="#krb5-cksumtype-to-string-convert-a-checksum-type-to-a-string" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_cksumtype_to_string"> -<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_cksumtype_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cksumtype_to_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_cksumtype_to_string"> +<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_cksumtype_to_string</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_cksumtype_to_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>cksumtype</strong> - Checksum type</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold converted checksum type</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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> -</div> +</dd> +</dl> +</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_cksumtype_to_string - Convert a checksum type to a string.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_clear_error_message.html b/doc/html/appdev/refs/api/krb5_clear_error_message.html index 3de92c2b9551..181e13e555cc 100644 --- a/doc/html/appdev/refs/api/krb5_clear_error_message.html +++ b/doc/html/appdev/refs/api/krb5_clear_error_message.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_clear_error_message - Clear the extended error message in a context. — 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_check_clockskew - Check if a timestamp is within the allowed clock skew of the current time." href="krb5_check_clockskew.html" /> <link rel="prev" title="krb5_cccol_have_content - Check if the credential cache collection contains any initialized caches." href="krb5_cccol_have_content.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,30 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-clear-error-message-clear-the-extended-error-message-in-a-context"> + <section id="krb5-clear-error-message-clear-the-extended-error-message-in-a-context"> <h1>krb5_clear_error_message - Clear the extended error message in a context.<a class="headerlink" href="#krb5-clear-error-message-clear-the-extended-error-message-in-a-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_clear_error_message"> -void <code class="descname">krb5_clear_error_message</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> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_clear_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_clear_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_clear_error_message</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">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_clear_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>ctx</strong> - Library context</td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> +</dd> +</dl> <p>This function unsets the extended error message in a context, to ensure that it is not mistakenly applied to another occurrence of the same error code.</p> -</div> +</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_clear_error_message - Clear the extended error message in a context.</a></li> @@ -128,6 +118,7 @@ void <code class="descname">krb5_clear_error_message</code><span class="sig-pare <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -135,8 +126,8 @@ void <code class="descname">krb5_clear_error_message</code><span class="sig-pare <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_addresses.html b/doc/html/appdev/refs/api/krb5_copy_addresses.html index 3f206df8b67b..bd2419a30d7e 100644 --- a/doc/html/appdev/refs/api/krb5_copy_addresses.html +++ b/doc/html/appdev/refs/api/krb5_copy_addresses.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_copy_addresses - Copy an array of addresses. — 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_copy_authdata - Copy an authorization data list." href="krb5_copy_authdata.html" /> <link rel="prev" title="krb5_check_clockskew - Check if a timestamp is within the allowed clock skew of the current time." href="krb5_check_clockskew.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-addresses-copy-an-array-of-addresses"> + <section id="krb5-copy-addresses-copy-an-array-of-addresses"> <h1>krb5_copy_addresses - Copy an array of addresses.<a class="headerlink" href="#krb5-copy-addresses-copy-an-array-of-addresses" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_addresses"> -<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_copy_addresses</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *const *<em> inaddr</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> ***<em> outaddr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_addresses" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_addresses"> +<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_copy_addresses</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">inaddr</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outaddr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_addresses" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>inaddr</strong> - Array of addresses to be copied</p> -<p class="last"><strong>[out]</strong> <strong>outaddr</strong> - Copy of array of addresses</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>outaddr</strong> - Copy of array of addresses</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> -<p>This function creates a new address array containing a copy of <em>inaddr</em> . Use <a class="reference internal" href="krb5_free_addresses.html#c.krb5_free_addresses" title="krb5_free_addresses"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_addresses()</span></code></a> to free <em>outaddr</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new address array containing a copy of <em>inaddr</em> . Use krb5_free_addresses() to free <em>outaddr</em> when it is no longer needed.</p> +</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_copy_addresses - Copy an array of addresses.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_authdata.html b/doc/html/appdev/refs/api/krb5_copy_authdata.html index 3497de370eb1..e9ab3e65a6df 100644 --- a/doc/html/appdev/refs/api/krb5_copy_authdata.html +++ b/doc/html/appdev/refs/api/krb5_copy_authdata.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_copy_authdata - Copy an authorization data list. — 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_copy_authenticator - Copy a krb5_authenticator structure." href="krb5_copy_authenticator.html" /> <link rel="prev" title="krb5_copy_addresses - Copy an array of addresses." href="krb5_copy_addresses.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-authdata-copy-an-authorization-data-list"> + <section id="krb5-copy-authdata-copy-an-authorization-data-list"> <h1>krb5_copy_authdata - Copy an authorization data list.<a class="headerlink" href="#krb5-copy-authdata-copy-an-authorization-data-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_authdata"> -<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_copy_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> in_authdat</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_authdata" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_authdata"> +<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_copy_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_authdat</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_authdata" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>in_authdat</strong> - List of <em>krb5_authdata</em> structures</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - New array of <em>krb5_authdata</em> structures</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>out</strong> - New array of <em>krb5_authdata</em> structures</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> -<p>This function creates a new authorization data list containing a copy of <em>in_authdat</em> , which must be null-terminated. Use <a class="reference internal" href="krb5_free_authdata.html#c.krb5_free_authdata" title="krb5_free_authdata"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_authdata()</span></code></a> to free <em>out</em> when it is no longer needed.</p> +</dd> +</dl> +<p>This function creates a new authorization data list containing a copy of <em>in_authdat</em> , which must be null-terminated. Use krb5_free_authdata() to free <em>out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The last array entry in <em>in_authdat</em> must be a NULL pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>The last array entry in <em>in_authdat</em> must be a NULL pointer.</p> </div> +</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_copy_authdata - Copy an authorization data list.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_authenticator.html b/doc/html/appdev/refs/api/krb5_copy_authenticator.html index 327e900fde71..3152f25e985b 100644 --- a/doc/html/appdev/refs/api/krb5_copy_authenticator.html +++ b/doc/html/appdev/refs/api/krb5_copy_authenticator.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_copy_authenticator - Copy a krb5_authenticator structure. — 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_copy_checksum - Copy a krb5_checksum structure." href="krb5_copy_checksum.html" /> <link rel="prev" title="krb5_copy_authdata - Copy an authorization data list." href="krb5_copy_authdata.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-authenticator-copy-a-krb5-authenticator-structure"> + <section id="krb5-copy-authenticator-copy-a-krb5-authenticator-structure"> <h1>krb5_copy_authenticator - Copy a krb5_authenticator structure.<a class="headerlink" href="#krb5-copy-authenticator-copy-a-krb5-authenticator-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_authenticator"> -<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_copy_authenticator</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_authenticator.html#c.krb5_authenticator" title="krb5_authenticator">krb5_authenticator</a> *<em> authfrom</em>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator">krb5_authenticator</a> **<em> authto</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_authenticator" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_authenticator"> +<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_copy_authenticator</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_authenticator.html#c.krb5_authenticator" title="krb5_authenticator"><span class="n"><span class="pre">krb5_authenticator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authfrom</span></span>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator"><span class="n"><span class="pre">krb5_authenticator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authto</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_authenticator" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>authfrom</strong> - krb5_authenticator structure to be copied</p> -<p class="last"><strong>[out]</strong> <strong>authto</strong> - Copy of krb5_authenticator structure</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>authto</strong> - Copy of krb5_authenticator structure</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> -<p>This function creates a new krb5_authenticator structure with the content of <em>authfrom</em> . Use <a class="reference internal" href="krb5_free_authenticator.html#c.krb5_free_authenticator" title="krb5_free_authenticator"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_authenticator()</span></code></a> to free <em>authto</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new krb5_authenticator structure with the content of <em>authfrom</em> . Use krb5_free_authenticator() to free <em>authto</em> when it is no longer needed.</p> +</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_copy_authenticator - Copy a krb5_authenticator structure.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_checksum.html b/doc/html/appdev/refs/api/krb5_copy_checksum.html index d1ab8e13d4b5..27e6189e2823 100644 --- a/doc/html/appdev/refs/api/krb5_copy_checksum.html +++ b/doc/html/appdev/refs/api/krb5_copy_checksum.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_copy_checksum - Copy a krb5_checksum structure. — 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_copy_context - Copy a krb5_context structure." href="krb5_copy_context.html" /> <link rel="prev" title="krb5_copy_authenticator - Copy a krb5_authenticator structure." href="krb5_copy_authenticator.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-checksum-copy-a-krb5-checksum-structure"> + <section id="krb5-copy-checksum-copy-a-krb5-checksum-structure"> <h1>krb5_copy_checksum - Copy a krb5_checksum structure.<a class="headerlink" href="#krb5-copy-checksum-copy-a-krb5-checksum-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_checksum"> -<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_copy_checksum</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_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> ckfrom</em>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> **<em> ckto</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_checksum"> +<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_copy_checksum</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_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ckfrom</span></span>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ckto</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ckfrom</strong> - Checksum to be copied</p> -<p class="last"><strong>[out]</strong> <strong>ckto</strong> - Copy of krb5_checksum structure</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>ckto</strong> - Copy of krb5_checksum structure</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> -<p>This function creates a new krb5_checksum structure with the contents of <em>ckfrom</em> . Use <a class="reference internal" href="krb5_free_checksum.html#c.krb5_free_checksum" title="krb5_free_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_checksum()</span></code></a> to free <em>ckto</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new krb5_checksum structure with the contents of <em>ckfrom</em> . Use krb5_free_checksum() to free <em>ckto</em> when it is no longer needed.</p> +</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_copy_checksum - Copy a krb5_checksum structure.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_context.html b/doc/html/appdev/refs/api/krb5_copy_context.html index 85015b88af61..c70c65d0e13e 100644 --- a/doc/html/appdev/refs/api/krb5_copy_context.html +++ b/doc/html/appdev/refs/api/krb5_copy_context.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_copy_context - Copy a krb5_context structure. — 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_copy_creds - Copy a krb5_creds structure." href="krb5_copy_creds.html" /> <link rel="prev" title="krb5_copy_checksum - Copy a krb5_checksum structure." href="krb5_copy_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-context-copy-a-krb5-context-structure"> + <section id="krb5-copy-context-copy-a-krb5-context-structure"> <h1>krb5_copy_context - Copy a krb5_context structure.<a class="headerlink" href="#krb5-copy-context-copy-a-krb5-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_context"> -<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_copy_context</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> ctx</em>, <a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> *<em> nctx_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_context" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_context"> +<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_copy_context</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">ctx</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">nctx_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_context" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> -<p class="last"><strong>[out]</strong> <strong>nctx_out</strong> - New context structure</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 simple"> -<li>0 Success</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> +<p><strong>[out]</strong> <strong>nctx_out</strong> - New context structure</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>The newly created context must be released by calling <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></code></a> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>The newly created context must be released by calling krb5_free_context() when it is no longer needed.</p> +</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_copy_context - Copy a krb5_context structure.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_creds.html b/doc/html/appdev/refs/api/krb5_copy_creds.html index 4ce872a48c56..888f06428f5a 100644 --- a/doc/html/appdev/refs/api/krb5_copy_creds.html +++ b/doc/html/appdev/refs/api/krb5_copy_creds.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_copy_creds - Copy a krb5_creds structure. — 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_copy_data - Copy a krb5_data object." href="krb5_copy_data.html" /> <link rel="prev" title="krb5_copy_context - Copy a krb5_context structure." href="krb5_copy_context.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-creds-copy-a-krb5-creds-structure"> + <section id="krb5-copy-creds-copy-a-krb5-creds-structure"> <h1>krb5_copy_creds - Copy a krb5_creds structure.<a class="headerlink" href="#krb5-copy-creds-copy-a-krb5-creds-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_creds"> -<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_copy_creds</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_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> incred</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> outcred</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_creds"> +<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_copy_creds</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_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">incred</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outcred</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>incred</strong> - Credentials structure to be copied</p> -<p class="last"><strong>[out]</strong> <strong>outcred</strong> - Copy of <em>incred</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>[out]</strong> <strong>outcred</strong> - Copy of <em>incred</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> -<p>This function creates a new credential with the contents of <em>incred</em> . Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></code></a> to free <em>outcred</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new credential with the contents of <em>incred</em> . Use krb5_free_creds() to free <em>outcred</em> when it is no longer needed.</p> +</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_copy_creds - Copy a krb5_creds structure.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_data.html b/doc/html/appdev/refs/api/krb5_copy_data.html index f87c15c44bf1..8db976600c5d 100644 --- a/doc/html/appdev/refs/api/krb5_copy_data.html +++ b/doc/html/appdev/refs/api/krb5_copy_data.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_copy_data - Copy a krb5_data object. — 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_copy_error_message - Copy the most recent extended error message from one context to another." href="krb5_copy_error_message.html" /> <link rel="prev" title="krb5_copy_creds - Copy a krb5_creds structure." href="krb5_copy_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-data-copy-a-krb5-data-object"> + <section id="krb5-copy-data-copy-a-krb5-data-object"> <h1>krb5_copy_data - Copy a krb5_data object.<a class="headerlink" href="#krb5-copy-data-copy-a-krb5-data-object" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_data"> -<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_copy_data</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> indata</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> **<em> outdata</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_data" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_data"> +<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_copy_data</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_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">indata</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">outdata</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_data" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>indata</strong> - Data object to be copied</p> -<p class="last"><strong>[out]</strong> <strong>outdata</strong> - Copy of <em>indata</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>[out]</strong> <strong>outdata</strong> - Copy of <em>indata</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> -<p>This function creates a new krb5_data object with the contents of <em>indata</em> . Use <a class="reference internal" href="krb5_free_data.html#c.krb5_free_data" title="krb5_free_data"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_data()</span></code></a> to free <em>outdata</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new krb5_data object with the contents of <em>indata</em> . Use krb5_free_data() to free <em>outdata</em> when it is no longer needed.</p> +</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_copy_data - Copy a krb5_data object.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_error_message.html b/doc/html/appdev/refs/api/krb5_copy_error_message.html index 2980c7830ac7..9619774c7e18 100644 --- a/doc/html/appdev/refs/api/krb5_copy_error_message.html +++ b/doc/html/appdev/refs/api/krb5_copy_error_message.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_copy_error_message - Copy the most recent extended error message from one context to another. — 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_copy_keyblock - Copy a keyblock." href="krb5_copy_keyblock.html" /> <link rel="prev" title="krb5_copy_data - Copy a krb5_data object." href="krb5_copy_data.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-error-message-copy-the-most-recent-extended-error-message-from-one-context-to-another"> + <section id="krb5-copy-error-message-copy-the-most-recent-extended-error-message-from-one-context-to-another"> <h1>krb5_copy_error_message - Copy the most recent extended error message from one context to another.<a class="headerlink" href="#krb5-copy-error-message-copy-the-most-recent-extended-error-message-from-one-context-to-another" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_error_message"> -void <code class="descname">krb5_copy_error_message</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> dest_ctx</em>, <a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a><em> src_ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_copy_error_message</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">dest_ctx</span></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">src_ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>dest_ctx</strong> - Library context to copy message to</p> -<p class="last"><strong>[in]</strong> <strong>src_ctx</strong> - Library context with current message</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>dest_ctx</strong> - Library context to copy message to</p> +<p><strong>[in]</strong> <strong>src_ctx</strong> - Library context with current message</p> +</dd> +</dl> +</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_copy_error_message - Copy the most recent extended error message from one context to another.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_copy_error_message</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_copy_error_message</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_keyblock.html b/doc/html/appdev/refs/api/krb5_copy_keyblock.html index cee45f829fdb..53b17d04d578 100644 --- a/doc/html/appdev/refs/api/krb5_copy_keyblock.html +++ b/doc/html/appdev/refs/api/krb5_copy_keyblock.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_copy_keyblock - Copy a 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> <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_copy_keyblock_contents - Copy the contents of a keyblock." href="krb5_copy_keyblock_contents.html" /> <link rel="prev" title="krb5_copy_error_message - Copy the most recent extended error message from one context to another." href="krb5_copy_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-keyblock-copy-a-keyblock"> + <section id="krb5-copy-keyblock-copy-a-keyblock"> <h1>krb5_copy_keyblock - Copy a keyblock.<a class="headerlink" href="#krb5-copy-keyblock-copy-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_keyblock"> -<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_copy_keyblock</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> from</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> to</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_keyblock" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_keyblock"> +<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_copy_keyblock</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">from</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">to</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_keyblock" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>from</strong> - Keyblock to be copied</p> -<p class="last"><strong>[out]</strong> <strong>to</strong> - Copy of keyblock <em>from</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>[out]</strong> <strong>to</strong> - Copy of keyblock <em>from</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> -<p>This function creates a new keyblock with the same contents as <em>from</em> . Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>to</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new keyblock with the same contents as <em>from</em> . Use krb5_free_keyblock() to free <em>to</em> when it is no longer needed.</p> +</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_copy_keyblock - Copy a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_keyblock_contents.html b/doc/html/appdev/refs/api/krb5_copy_keyblock_contents.html index e5c06adee850..807e5c1fa5e9 100644 --- a/doc/html/appdev/refs/api/krb5_copy_keyblock_contents.html +++ b/doc/html/appdev/refs/api/krb5_copy_keyblock_contents.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_copy_keyblock_contents - Copy the contents of a 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> <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_copy_principal - Copy a principal." href="krb5_copy_principal.html" /> <link rel="prev" title="krb5_copy_keyblock - Copy a keyblock." href="krb5_copy_keyblock.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-keyblock-contents-copy-the-contents-of-a-keyblock"> + <section id="krb5-copy-keyblock-contents-copy-the-contents-of-a-keyblock"> <h1>krb5_copy_keyblock_contents - Copy the contents of a keyblock.<a class="headerlink" href="#krb5-copy-keyblock-contents-copy-the-contents-of-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_keyblock_contents"> -<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_copy_keyblock_contents</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> from</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> to</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_keyblock_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_keyblock_contents"> +<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_copy_keyblock_contents</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">from</span></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">to</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_keyblock_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>from</strong> - Key to be copied</p> -<p class="last"><strong>[out]</strong> <strong>to</strong> - Output key</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>to</strong> - Output key</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> -<p>This function copies the contents of <em>from</em> to <em>to</em> . Use <a class="reference internal" href="krb5_free_keyblock_contents.html#c.krb5_free_keyblock_contents" title="krb5_free_keyblock_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock_contents()</span></code></a> to free <em>to</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function copies the contents of <em>from</em> to <em>to</em> . Use krb5_free_keyblock_contents() to free <em>to</em> when it is no longer needed.</p> +</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_copy_keyblock_contents - Copy the contents of a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_principal.html b/doc/html/appdev/refs/api/krb5_copy_principal.html index fd81ebf33c4c..65e48948d8c3 100644 --- a/doc/html/appdev/refs/api/krb5_copy_principal.html +++ b/doc/html/appdev/refs/api/krb5_copy_principal.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_copy_principal - Copy a principal. — 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_copy_ticket - Copy a krb5_ticket structure." href="krb5_copy_ticket.html" /> <link rel="prev" title="krb5_copy_keyblock_contents - Copy the contents of a keyblock." href="krb5_copy_keyblock_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-principal-copy-a-principal"> + <section id="krb5-copy-principal-copy-a-principal"> <h1>krb5_copy_principal - Copy a principal.<a class="headerlink" href="#krb5-copy-principal-copy-a-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_principal"> -<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_copy_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> inprinc</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> outprinc</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_principal"> +<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_copy_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">inprinc</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outprinc</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>inprinc</strong> - Principal to be copied</p> -<p class="last"><strong>[out]</strong> <strong>outprinc</strong> - Copy of <em>inprinc</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>[out]</strong> <strong>outprinc</strong> - Copy of <em>inprinc</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> -<p>This function creates a new principal structure with the contents of <em>inprinc</em> . Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>outprinc</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new principal structure with the contents of <em>inprinc</em> . Use krb5_free_principal() to free <em>outprinc</em> when it is no longer needed.</p> +</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_copy_principal - Copy a principal.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_copy_ticket.html b/doc/html/appdev/refs/api/krb5_copy_ticket.html index cf9bb98823cb..63cbd1f019b0 100644 --- a/doc/html/appdev/refs/api/krb5_copy_ticket.html +++ b/doc/html/appdev/refs/api/krb5_copy_ticket.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_copy_ticket - Copy a krb5_ticket structure. — 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_find_authdata - Find authorization data elements." href="krb5_find_authdata.html" /> <link rel="prev" title="krb5_copy_principal - Copy a principal." href="krb5_copy_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-copy-ticket-copy-a-krb5-ticket-structure"> + <section id="krb5-copy-ticket-copy-a-krb5-ticket-structure"> <h1>krb5_copy_ticket - Copy a krb5_ticket structure.<a class="headerlink" href="#krb5-copy-ticket-copy-a-krb5-ticket-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_copy_ticket"> -<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_copy_ticket</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_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> *<em> from</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> **<em> pto</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_ticket" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_copy_ticket"> +<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_copy_ticket</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_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">from</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pto</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_copy_ticket" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>from</strong> - Ticket to be copied</p> -<p class="last"><strong>[out]</strong> <strong>pto</strong> - Copy of ticket</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>pto</strong> - Copy of ticket</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> -<p>This function creates a new krb5_ticket structure containing the contents of <em>from</em> . Use <a class="reference internal" href="krb5_free_ticket.html#c.krb5_free_ticket" title="krb5_free_ticket"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_ticket()</span></code></a> to free <em>pto</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a new krb5_ticket structure containing the contents of <em>from</em> . Use krb5_free_ticket() to free <em>pto</em> when it is no longer needed.</p> +</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_copy_ticket - Copy a krb5_ticket structure.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_decode_authdata_container.html b/doc/html/appdev/refs/api/krb5_decode_authdata_container.html index 519428f771b0..dcb1eb7482a2 100644 --- a/doc/html/appdev/refs/api/krb5_decode_authdata_container.html +++ b/doc/html/appdev/refs/api/krb5_decode_authdata_container.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_decode_authdata_container - Unwrap authorization data. — 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_decode_ticket - Decode an ASN.1-formatted ticket." href="krb5_decode_ticket.html" /> <link rel="prev" title="krb5_cksumtype_to_string - Convert a checksum type to a string." href="krb5_cksumtype_to_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-decode-authdata-container-unwrap-authorization-data"> + <section id="krb5-decode-authdata-container-unwrap-authorization-data"> <h1>krb5_decode_authdata_container - Unwrap authorization data.<a class="headerlink" href="#krb5-decode-authdata-container-unwrap-authorization-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_decode_authdata_container"> -<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_decode_authdata_container</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>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype">krb5_authdatatype</a><em> type</em>, const <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *<em> container</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> authdata</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decode_authdata_container" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_decode_authdata_container"> +<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_decode_authdata_container</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>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype"><span class="n"><span class="pre">krb5_authdatatype</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">container</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authdata</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decode_authdata_container" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p><strong>[in]</strong> <strong>type</strong> - <code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTHDATA</span></code> type of <em>container</em></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>type</strong> - Container type (see KRB5_AUTHDATA macros)</p> <p><strong>[in]</strong> <strong>container</strong> - Authorization data to be decoded</p> -<p class="last"><strong>[out]</strong> <strong>authdata</strong> - List of decoded authorization 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>authdata</strong> - List of decoded authorization 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> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_encode_authdata_container.html#c.krb5_encode_authdata_container" title="krb5_encode_authdata_container"><code class="xref c c-func docutils literal"><span class="pre">krb5_encode_authdata_container()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_encode_authdata_container()</p> </div> +</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_decode_authdata_container - Unwrap authorization data.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_decode_ticket.html b/doc/html/appdev/refs/api/krb5_decode_ticket.html index dff836a80830..2ee5227bb34e 100644 --- a/doc/html/appdev/refs/api/krb5_decode_ticket.html +++ b/doc/html/appdev/refs/api/krb5_decode_ticket.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_decode_ticket - Decode an ASN.1-formatted ticket. — 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_deltat_to_string - Convert a relative time value to a string." href="krb5_deltat_to_string.html" /> <link rel="prev" title="krb5_decode_authdata_container - Unwrap authorization data." href="krb5_decode_authdata_container.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-decode-ticket-decode-an-asn-1-formatted-ticket"> + <section id="krb5-decode-ticket-decode-an-asn-1-formatted-ticket"> <h1>krb5_decode_ticket - Decode an ASN.1-formatted ticket.<a class="headerlink" href="#krb5-decode-ticket-decode-an-asn-1-formatted-ticket" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_decode_ticket"> -<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_decode_ticket</code><span class="sig-paren">(</span>const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> code</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> **<em> rep</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decode_ticket" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_decode_ticket"> +<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_decode_ticket</span></span></span><span class="sig-paren">(</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">code</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rep</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decode_ticket" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>code</strong> - ASN.1-formatted ticket</p> -<p class="last"><strong>[out]</strong> <strong>rep</strong> - Decoded ticket information</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> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>code</strong> - ASN.1-formatted ticket</p> +<p><strong>[out]</strong> <strong>rep</strong> - Decoded ticket information</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> -</div> +</dd> +</dl> +</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_decode_ticket - Decode an ASN.1-formatted ticket.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_decrypt.html b/doc/html/appdev/refs/api/krb5_decrypt.html index 801bfd0cfee8..dac5f0e1265a 100644 --- a/doc/html/appdev/refs/api/krb5_decrypt.html +++ b/doc/html/appdev/refs/api/krb5_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_decrypt — 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_eblock_enctype" href="krb5_eblock_enctype.html" /> <link rel="prev" title="krb5_encrypt" href="krb5_encrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,36 +52,34 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-decrypt"> + <section id="krb5-decrypt"> <h1>krb5_decrypt<a class="headerlink" href="#krb5-decrypt" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_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_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>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> inptr</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> outptr</em>, size_t<em> size</em>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> ivec</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decrypt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_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_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>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">inptr</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">outptr</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">ivec</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_decrypt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>inptr</strong></p> <p><strong>outptr</strong></p> <p><strong>size</strong></p> <p><strong>eblock</strong></p> -<p class="last"><strong>ivec</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>ivec</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_decrypt</a></li> @@ -134,6 +123,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_deltat_to_string.html b/doc/html/appdev/refs/api/krb5_deltat_to_string.html index 679b923fab65..911cb0c25ebe 100644 --- a/doc/html/appdev/refs/api/krb5_deltat_to_string.html +++ b/doc/html/appdev/refs/api/krb5_deltat_to_string.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_deltat_to_string - Convert a relative time value to a string. — 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_encode_authdata_container - Wrap authorization data in a container." href="krb5_encode_authdata_container.html" /> <link rel="prev" title="krb5_decode_ticket - Decode an ASN.1-formatted ticket." href="krb5_decode_ticket.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-deltat-to-string-convert-a-relative-time-value-to-a-string"> + <section id="krb5-deltat-to-string-convert-a-relative-time-value-to-a-string"> <h1>krb5_deltat_to_string - Convert a relative time value to a string.<a class="headerlink" href="#krb5-deltat-to-string-convert-a-relative-time-value-to-a-string" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_deltat_to_string"> -<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_deltat_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> deltat</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_deltat_to_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_deltat_to_string"> +<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_deltat_to_string</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">deltat</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_deltat_to_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>deltat</strong> - Relative time value to convert</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>deltat</strong> - Relative time value to convert</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold time string</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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> -</div> +</dd> +</dl> +</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_deltat_to_string - Convert a relative time value to a string.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_eblock_enctype.html b/doc/html/appdev/refs/api/krb5_eblock_enctype.html index 2d15a093938b..46a44a01448e 100644 --- a/doc/html/appdev/refs/api/krb5_eblock_enctype.html +++ b/doc/html/appdev/refs/api/krb5_eblock_enctype.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_eblock_enctype — 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_encrypt_size" href="krb5_encrypt_size.html" /> <link rel="prev" title="krb5_decrypt" href="krb5_decrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-eblock-enctype"> + <section id="krb5-eblock-enctype"> <h1>krb5_eblock_enctype<a class="headerlink" href="#krb5-eblock-enctype" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_eblock_enctype"> -<a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> <code class="descname">krb5_eblock_enctype</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_eblock_enctype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_eblock_enctype"> +<a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_eblock_enctype</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_eblock_enctype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>eblock</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>eblock</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_eblock_enctype</a></li> @@ -130,6 +119,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_encode_authdata_container.html b/doc/html/appdev/refs/api/krb5_encode_authdata_container.html index cb576310e537..3bb14a9bd02c 100644 --- a/doc/html/appdev/refs/api/krb5_encode_authdata_container.html +++ b/doc/html/appdev/refs/api/krb5_encode_authdata_container.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_encode_authdata_container - Wrap authorization data in a container. — 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_enctype_to_name - Convert an encryption type to a name or alias." href="krb5_enctype_to_name.html" /> <link rel="prev" title="krb5_deltat_to_string - Convert a relative time value to a string." href="krb5_deltat_to_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-encode-authdata-container-wrap-authorization-data-in-a-container"> + <section id="krb5-encode-authdata-container-wrap-authorization-data-in-a-container"> <h1>krb5_encode_authdata_container - Wrap authorization data in a container.<a class="headerlink" href="#krb5-encode-authdata-container-wrap-authorization-data-in-a-container" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_encode_authdata_container"> -<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_encode_authdata_container</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>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype">krb5_authdatatype</a><em> type</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> authdata</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> container</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encode_authdata_container" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_encode_authdata_container"> +<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_encode_authdata_container</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>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype"><span class="n"><span class="pre">krb5_authdatatype</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authdata</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">container</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encode_authdata_container" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p><strong>[in]</strong> <strong>type</strong> - <code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTHDATA</span></code> type of <em>container</em></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>type</strong> - Container type (see KRB5_AUTHDATA macros)</p> <p><strong>[in]</strong> <strong>authdata</strong> - List of authorization data to be encoded</p> -<p class="last"><strong>[out]</strong> <strong>container</strong> - List of encoded authorization 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>container</strong> - List of encoded authorization 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>The result is returned in <em>container</em> as a single-element list.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_decode_authdata_container.html#c.krb5_decode_authdata_container" title="krb5_decode_authdata_container"><code class="xref c c-func docutils literal"><span class="pre">krb5_decode_authdata_container()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_decode_authdata_container()</p> </div> +</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_encode_authdata_container - Wrap authorization data in a container.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_encrypt.html b/doc/html/appdev/refs/api/krb5_encrypt.html index fa4aad916a12..76414f03ed4c 100644 --- a/doc/html/appdev/refs/api/krb5_encrypt.html +++ b/doc/html/appdev/refs/api/krb5_encrypt.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_encrypt — 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_decrypt" href="krb5_decrypt.html" /> <link rel="prev" title="krb5_checksum_size" href="krb5_checksum_size.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,36 +52,34 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-encrypt"> + <section id="krb5-encrypt"> <h1>krb5_encrypt<a class="headerlink" href="#krb5-encrypt" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_encrypt"> -<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_encrypt</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>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> inptr</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> outptr</em>, size_t<em> size</em>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> ivec</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encrypt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_encrypt"> +<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_encrypt</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>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">inptr</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">outptr</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">size</span></span>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">ivec</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encrypt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>inptr</strong></p> <p><strong>outptr</strong></p> <p><strong>size</strong></p> <p><strong>eblock</strong></p> -<p class="last"><strong>ivec</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>ivec</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_encrypt</a></li> @@ -134,6 +123,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_encrypt_size.html b/doc/html/appdev/refs/api/krb5_encrypt_size.html index 07b30d8baa26..cf818b2c498b 100644 --- a/doc/html/appdev/refs/api/krb5_encrypt_size.html +++ b/doc/html/appdev/refs/api/krb5_encrypt_size.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_encrypt_size — 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_finish_key" href="krb5_finish_key.html" /> <link rel="prev" title="krb5_eblock_enctype" href="krb5_eblock_enctype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-encrypt-size"> + <section id="krb5-encrypt-size"> <h1>krb5_encrypt_size<a class="headerlink" href="#krb5-encrypt-size" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_encrypt_size"> -size_t <code class="descname">krb5_encrypt_size</code><span class="sig-paren">(</span>size_t<em> length</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> crypto</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encrypt_size" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_encrypt_size"> +<span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_encrypt_size</span></span></span><span class="sig-paren">(</span><span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">length</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">crypto</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_encrypt_size" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>length</strong></p> -<p class="last"><strong>crypto</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>length</strong></p> +<p><strong>crypto</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_encrypt_size</a></li> @@ -130,6 +119,7 @@ size_t <code class="descname">krb5_encrypt_size</code><span class="sig-paren">(< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ size_t <code class="descname">krb5_encrypt_size</code><span class="sig-paren">(< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_enctype_to_name.html b/doc/html/appdev/refs/api/krb5_enctype_to_name.html index c8ca2615528c..46fc5d8484ca 100644 --- a/doc/html/appdev/refs/api/krb5_enctype_to_name.html +++ b/doc/html/appdev/refs/api/krb5_enctype_to_name.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_enctype_to_name - Convert an encryption type to a name or alias. — 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_enctype_to_string - Convert an encryption type to a string." href="krb5_enctype_to_string.html" /> <link rel="prev" title="krb5_encode_authdata_container - Wrap authorization data in a container." href="krb5_encode_authdata_container.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-enctype-to-name-convert-an-encryption-type-to-a-name-or-alias"> + <section id="krb5-enctype-to-name-convert-an-encryption-type-to-a-name-or-alias"> <h1>krb5_enctype_to_name - Convert an encryption type to a name or alias.<a class="headerlink" href="#krb5-enctype-to-name-convert-an-encryption-type-to-a-name-or-alias" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_enctype_to_name"> -<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_enctype_to_name</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> shortest</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_enctype_to_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_enctype_to_name"> +<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_enctype_to_name</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">shortest</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_enctype_to_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>shortest</strong> - Flag</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold encryption type string</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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>If <em>shortest</em> is FALSE, this function returns the enctype’s canonical name (like”aes128-cts-hmac-sha1-96”). If <em>shortest</em> is TRUE, it return the enctype’s shortest alias (like”aes128-cts”).</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_enctype_to_name - Convert an encryption type to a name or alias.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_enctype_to_string.html b/doc/html/appdev/refs/api/krb5_enctype_to_string.html index 6240a503b2e8..82695b0747fc 100644 --- a/doc/html/appdev/refs/api/krb5_enctype_to_string.html +++ b/doc/html/appdev/refs/api/krb5_enctype_to_string.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_enctype_to_string - Convert an encryption type to a string. — 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_free_checksum - Free a krb5_checksum structure." href="krb5_free_checksum.html" /> <link rel="prev" title="krb5_enctype_to_name - Convert an encryption type to a name or alias." href="krb5_enctype_to_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-enctype-to-string-convert-an-encryption-type-to-a-string"> + <section id="krb5-enctype-to-string-convert-an-encryption-type-to-a-string"> <h1>krb5_enctype_to_string - Convert an encryption type to a string.<a class="headerlink" href="#krb5-enctype-to-string-convert-an-encryption-type-to-a-string" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_enctype_to_string"> -<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_enctype_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_enctype_to_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_enctype_to_string"> +<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_enctype_to_string</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_enctype_to_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>enctype</strong> - Encryption type</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold encryption type string</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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> -</div> +</dd> +</dl> +</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_enctype_to_string - Convert an encryption type to a string.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_expand_hostname.html b/doc/html/appdev/refs/api/krb5_expand_hostname.html index 08f0f02e1333..afd64130a4ea 100644 --- a/doc/html/appdev/refs/api/krb5_expand_hostname.html +++ b/doc/html/appdev/refs/api/krb5_expand_hostname.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_expand_hostname - Canonicalize a hostname, possibly using name service. — 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_free_context - Free a krb5 library context." href="krb5_free_context.html" /> <link rel="prev" title="krb5_chpw_message - Get a result message for changing or setting a password." href="krb5_chpw_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-expand-hostname-canonicalize-a-hostname-possibly-using-name-service"> + <section id="krb5-expand-hostname-canonicalize-a-hostname-possibly-using-name-service"> <h1>krb5_expand_hostname - Canonicalize a hostname, possibly using name service.<a class="headerlink" href="#krb5-expand-hostname-canonicalize-a-hostname-possibly-using-name-service" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_expand_hostname"> -<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_expand_hostname</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 char *<em> host</em>, char **<em> canonhost_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_expand_hostname" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_expand_hostname"> +<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_expand_hostname</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">host</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">canonhost_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_expand_hostname" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>host</strong> - Input hostname</p> -<p class="last"><strong>[out]</strong> <strong>canonhost_out</strong> - Canonicalized hostname</p> -</td> -</tr> -</tbody> -</table> -<p>This function canonicalizes orig_hostname, possibly using name service lookups if configuration permits. Use <a class="reference internal" href="krb5_free_string.html#c.krb5_free_string" title="krb5_free_string"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_string()</span></code></a> to free <em>canonhost_out</em> when it is no longer needed.</p> +<p><strong>[out]</strong> <strong>canonhost_out</strong> - Canonicalized hostname</p> +</dd> +</dl> +<p>This function canonicalizes orig_hostname, possibly using name service lookups if configuration permits. Use krb5_free_string() to free <em>canonhost_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.15</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.15</p> </div> +</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_expand_hostname - Canonicalize a hostname, possibly using name service.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_find_authdata.html b/doc/html/appdev/refs/api/krb5_find_authdata.html index fdd5a7e90031..71c21943287e 100644 --- a/doc/html/appdev/refs/api/krb5_find_authdata.html +++ b/doc/html/appdev/refs/api/krb5_find_authdata.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_find_authdata - Find authorization data elements. — 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_free_addresses - Free the data stored in array of addresses." href="krb5_free_addresses.html" /> <link rel="prev" title="krb5_copy_ticket - Copy a krb5_ticket structure." href="krb5_copy_ticket.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,39 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-find-authdata-find-authorization-data-elements"> + <section id="krb5-find-authdata-find-authorization-data-elements"> <h1>krb5_find_authdata - Find authorization data elements.<a class="headerlink" href="#krb5-find-authdata-find-authorization-data-elements" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_find_authdata"> -<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_find_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> ticket_authdata</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> ap_req_authdata</em>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype">krb5_authdatatype</a><em> ad_type</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> results</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_find_authdata" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_find_authdata"> +<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_find_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ticket_authdata</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ap_req_authdata</span></span>, <a class="reference internal" href="../types/krb5_authdatatype.html#c.krb5_authdatatype" title="krb5_authdatatype"><span class="n"><span class="pre">krb5_authdatatype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ad_type</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">results</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_find_authdata" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ticket_authdata</strong> - Authorization data list from ticket</p> <p><strong>[in]</strong> <strong>ap_req_authdata</strong> - Authorization data list from AP request</p> <p><strong>[in]</strong> <strong>ad_type</strong> - Authorization data type to find</p> -<p class="last"><strong>[out]</strong> <strong>results</strong> - List of matching entries</p> -</td> -</tr> -</tbody> -</table> -<p>This function searches <em>ticket_authdata</em> and <em>ap_req_authdata</em> for elements of type <em>ad_type</em> . Either input list may be NULL, in which case it will not be searched; otherwise, the input lists must be terminated by NULL entries. This function will search inside AD-IF-RELEVANT containers if found in either list. Use <a class="reference internal" href="krb5_free_authdata.html#c.krb5_free_authdata" title="krb5_free_authdata"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_authdata()</span></code></a> to free <em>results</em> when it is no longer needed.</p> +<p><strong>[out]</strong> <strong>results</strong> - List of matching entries</p> +</dd> +</dl> +<p>This function searches <em>ticket_authdata</em> and <em>ap_req_authdata</em> for elements of type <em>ad_type</em> . Either input list may be NULL, in which case it will not be searched; otherwise, the input lists must be terminated by NULL entries. This function will search inside AD-IF-RELEVANT containers if found in either list. Use krb5_free_authdata() to free <em>results</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_find_authdata - Find authorization data elements.</a></li> @@ -137,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -144,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_finish_key.html b/doc/html/appdev/refs/api/krb5_finish_key.html index 15507369f398..94313bbda8e9 100644 --- a/doc/html/appdev/refs/api/krb5_finish_key.html +++ b/doc/html/appdev/refs/api/krb5_finish_key.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_finish_key — 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_finish_random_key" href="krb5_finish_random_key.html" /> <link rel="prev" title="krb5_encrypt_size" href="krb5_encrypt_size.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-finish-key"> + <section id="krb5-finish-key"> <h1>krb5_finish_key<a class="headerlink" href="#krb5-finish-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_finish_key"> -<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_finish_key</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_finish_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_finish_key"> +<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_finish_key</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_finish_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>eblock</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>eblock</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_finish_key</a></li> @@ -130,6 +119,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_finish_random_key.html b/doc/html/appdev/refs/api/krb5_finish_random_key.html index 45e169fbe297..bfdeb4ffdbe8 100644 --- a/doc/html/appdev/refs/api/krb5_finish_random_key.html +++ b/doc/html/appdev/refs/api/krb5_finish_random_key.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_finish_random_key — 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_cc_gen_new" href="krb5_cc_gen_new.html" /> <link rel="prev" title="krb5_finish_key" href="krb5_finish_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-finish-random-key"> + <section id="krb5-finish-random-key"> <h1>krb5_finish_random_key<a class="headerlink" href="#krb5-finish-random-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_finish_random_key"> -<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_finish_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a> *<em> ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_finish_random_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_finish_random_key"> +<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_finish_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ptr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_finish_random_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> -<p class="last"><strong>ptr</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>ptr</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_finish_random_key</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_addresses.html b/doc/html/appdev/refs/api/krb5_free_addresses.html index f46f6e139c3a..deaab4111494 100644 --- a/doc/html/appdev/refs/api/krb5_free_addresses.html +++ b/doc/html/appdev/refs/api/krb5_free_addresses.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_free_addresses - Free the data stored in array of addresses. — 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_free_ap_rep_enc_part - Free a krb5_ap_rep_enc_part structure." href="krb5_free_ap_rep_enc_part.html" /> <link rel="prev" title="krb5_find_authdata - Find authorization data elements." href="krb5_find_authdata.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,36 +52,34 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-addresses-free-the-data-stored-in-array-of-addresses"> + <section id="krb5-free-addresses-free-the-data-stored-in-array-of-addresses"> <h1>krb5_free_addresses - Free the data stored in array of addresses.<a class="headerlink" href="#krb5-free-addresses-free-the-data-stored-in-array-of-addresses" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_addresses"> -void <code class="descname">krb5_free_addresses</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> **<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_addresses" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_addresses"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_addresses</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_addresses" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Array of addresses to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Array of addresses to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the array itself.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The last entry in the array must be a NULL pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>The last entry in the array must be a NULL pointer.</p> </div> +</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_free_addresses - Free the data stored in array of addresses.</a></li> @@ -134,6 +123,7 @@ void <code class="descname">krb5_free_addresses</code><span class="sig-paren">(< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ void <code class="descname">krb5_free_addresses</code><span class="sig-paren">(< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_ap_rep_enc_part.html b/doc/html/appdev/refs/api/krb5_free_ap_rep_enc_part.html index 6c984fcecd29..9c15e48f7686 100644 --- a/doc/html/appdev/refs/api/krb5_free_ap_rep_enc_part.html +++ b/doc/html/appdev/refs/api/krb5_free_ap_rep_enc_part.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_free_ap_rep_enc_part - Free a krb5_ap_rep_enc_part structure. — 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_free_authdata - Free the storage assigned to array of authentication data." href="krb5_free_authdata.html" /> <link rel="prev" title="krb5_free_addresses - Free the data stored in array of addresses." href="krb5_free_addresses.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-ap-rep-enc-part-free-a-krb5-ap-rep-enc-part-structure"> + <section id="krb5-free-ap-rep-enc-part-free-a-krb5-ap-rep-enc-part-structure"> <h1>krb5_free_ap_rep_enc_part - Free a krb5_ap_rep_enc_part structure.<a class="headerlink" href="#krb5-free-ap-rep-enc-part-free-a-krb5-ap-rep-enc-part-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_ap_rep_enc_part"> -void <code class="descname">krb5_free_ap_rep_enc_part</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>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part">krb5_ap_rep_enc_part</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_ap_rep_enc_part" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_ap_rep_enc_part"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_ap_rep_enc_part</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>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part"><span class="n"><span class="pre">krb5_ap_rep_enc_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_ap_rep_enc_part" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - AP-REP enc part to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - AP-REP enc part to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_ap_rep_enc_part - Free a krb5_ap_rep_enc_part structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_ap_rep_enc_part</code><span class="sig-par <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_ap_rep_enc_part</code><span class="sig-par <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_authdata.html b/doc/html/appdev/refs/api/krb5_free_authdata.html index aac468a906d8..1c5218899252 100644 --- a/doc/html/appdev/refs/api/krb5_free_authdata.html +++ b/doc/html/appdev/refs/api/krb5_free_authdata.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_free_authdata - Free the storage assigned to array of authentication data. — 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_free_authenticator - Free a krb5_authenticator structure." href="krb5_free_authenticator.html" /> <link rel="prev" title="krb5_free_ap_rep_enc_part - Free a krb5_ap_rep_enc_part structure." href="krb5_free_ap_rep_enc_part.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,36 +52,34 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-authdata-free-the-storage-assigned-to-array-of-authentication-data"> + <section id="krb5-free-authdata-free-the-storage-assigned-to-array-of-authentication-data"> <h1>krb5_free_authdata - Free the storage assigned to array of authentication data.<a class="headerlink" href="#krb5-free-authdata-free-the-storage-assigned-to-array-of-authentication-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_authdata"> -void <code class="descname">krb5_free_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> **<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_authdata" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_authdata"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_authdata" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Array of authentication data to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Array of authentication data to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the array itself.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The last entry in the array must be a NULL pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>The last entry in the array must be a NULL pointer.</p> </div> +</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_free_authdata - Free the storage assigned to array of authentication data.</a></li> @@ -134,6 +123,7 @@ void <code class="descname">krb5_free_authdata</code><span class="sig-paren">(</ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ void <code class="descname">krb5_free_authdata</code><span class="sig-paren">(</ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_authenticator.html b/doc/html/appdev/refs/api/krb5_free_authenticator.html index 948de73eb5b7..897427ef5bc0 100644 --- a/doc/html/appdev/refs/api/krb5_free_authenticator.html +++ b/doc/html/appdev/refs/api/krb5_free_authenticator.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_free_authenticator - Free a krb5_authenticator structure. — 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_free_cred_contents - Free the contents of a krb5_creds structure." href="krb5_free_cred_contents.html" /> <link rel="prev" title="krb5_free_authdata - Free the storage assigned to array of authentication data." href="krb5_free_authdata.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-authenticator-free-a-krb5-authenticator-structure"> + <section id="krb5-free-authenticator-free-a-krb5-authenticator-structure"> <h1>krb5_free_authenticator - Free a krb5_authenticator structure.<a class="headerlink" href="#krb5-free-authenticator-free-a-krb5-authenticator-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_authenticator"> -void <code class="descname">krb5_free_authenticator</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>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator">krb5_authenticator</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_authenticator" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_authenticator"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_authenticator</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>, <a class="reference internal" href="../types/krb5_authenticator.html#c.krb5_authenticator" title="krb5_authenticator"><span class="n"><span class="pre">krb5_authenticator</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_authenticator" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Authenticator structure to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Authenticator structure to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_authenticator - Free a krb5_authenticator structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_authenticator</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_authenticator</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_checksum.html b/doc/html/appdev/refs/api/krb5_free_checksum.html index 7299b6bcf18c..3f366e65363a 100644 --- a/doc/html/appdev/refs/api/krb5_free_checksum.html +++ b/doc/html/appdev/refs/api/krb5_free_checksum.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_free_checksum - Free a krb5_checksum structure. — 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_free_checksum_contents - Free the contents of a krb5_checksum structure." href="krb5_free_checksum_contents.html" /> <link rel="prev" title="krb5_enctype_to_string - Convert an encryption type to a string." href="krb5_enctype_to_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-checksum-free-a-krb5-checksum-structure"> + <section id="krb5-free-checksum-free-a-krb5-checksum-structure"> <h1>krb5_free_checksum - Free a krb5_checksum structure.<a class="headerlink" href="#krb5-free-checksum-free-a-krb5-checksum-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_checksum"> -void <code class="descname">krb5_free_checksum</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>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_checksum"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_checksum</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>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Checksum structure to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Checksum structure to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_checksum - Free a krb5_checksum structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_checksum</code><span class="sig-paren">(</ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_checksum</code><span class="sig-paren">(</ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_checksum_contents.html b/doc/html/appdev/refs/api/krb5_free_checksum_contents.html index fcf70c46cb89..74e81e83c8bc 100644 --- a/doc/html/appdev/refs/api/krb5_free_checksum_contents.html +++ b/doc/html/appdev/refs/api/krb5_free_checksum_contents.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_free_checksum_contents - Free the contents of a krb5_checksum structure. — 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_free_cksumtypes - Free an array of checksum types." href="krb5_free_cksumtypes.html" /> <link rel="prev" title="krb5_free_checksum - Free a krb5_checksum structure." href="krb5_free_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-checksum-contents-free-the-contents-of-a-krb5-checksum-structure"> + <section id="krb5-free-checksum-contents-free-the-contents-of-a-krb5-checksum-structure"> <h1>krb5_free_checksum_contents - Free the contents of a krb5_checksum structure.<a class="headerlink" href="#krb5-free-checksum-contents-free-the-contents-of-a-krb5-checksum-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_checksum_contents"> -void <code class="descname">krb5_free_checksum_contents</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>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_checksum_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_checksum_contents"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_checksum_contents</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>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_checksum_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Checksum structure to free contents of</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Checksum structure to free contents of</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> , but not the structure itself. It sets the checksum’s data pointer to null and (beginning in release 1.19) sets its length to zero.</p> -</div> +</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_free_checksum_contents - Free the contents of a krb5_checksum structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_checksum_contents</code><span class="sig-p <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_checksum_contents</code><span class="sig-p <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_cksumtypes.html b/doc/html/appdev/refs/api/krb5_free_cksumtypes.html index 49a74fee29e1..7c9c207a7262 100644 --- a/doc/html/appdev/refs/api/krb5_free_cksumtypes.html +++ b/doc/html/appdev/refs/api/krb5_free_cksumtypes.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_free_cksumtypes - Free an array of checksum types. — 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_free_tgt_creds - Free an array of credential structures." href="krb5_free_tgt_creds.html" /> <link rel="prev" title="krb5_free_checksum_contents - Free the contents of a krb5_checksum structure." href="krb5_free_checksum_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-cksumtypes-free-an-array-of-checksum-types"> + <section id="krb5-free-cksumtypes-free-an-array-of-checksum-types"> <h1>krb5_free_cksumtypes - Free an array of checksum types.<a class="headerlink" href="#krb5-free-cksumtypes-free-an-array-of-checksum-types" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_cksumtypes"> -void <code class="descname">krb5_free_cksumtypes</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_cksumtypes" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_cksumtypes"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_cksumtypes</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_cksumtypes" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Array of checksum types to be freed</p> -</td> -</tr> -</tbody> -</table> -</div> +<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>val</strong> - Array of checksum types to be freed</p> +</dd> +</dl> +</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_free_cksumtypes - Free an array of checksum types.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_free_cksumtypes</code><span class="sig-paren">( <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_free_cksumtypes</code><span class="sig-paren">( <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_context.html b/doc/html/appdev/refs/api/krb5_free_context.html index 3c3b4a0fdd87..253bfb23fd73 100644 --- a/doc/html/appdev/refs/api/krb5_free_context.html +++ b/doc/html/appdev/refs/api/krb5_free_context.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_free_context - Free a krb5 library context. — 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_free_error_message - Free an error message generated by krb5_get_error_message() ." href="krb5_free_error_message.html" /> + <link rel="next" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." href="krb5_free_error_message.html" /> <link rel="prev" title="krb5_expand_hostname - Canonicalize a hostname, possibly using name service." href="krb5_expand_hostname.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,7 +33,7 @@ accesskey="C">Contents</a> | <a href="krb5_expand_hostname.html" title="krb5_expand_hostname - Canonicalize a hostname, possibly using name service." accesskey="P">previous</a> | - <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message() ." + <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,30 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-context-free-a-krb5-library-context"> + <section id="krb5-free-context-free-a-krb5-library-context"> <h1>krb5_free_context - Free a krb5 library context.<a class="headerlink" href="#krb5-free-context-free-a-krb5-library-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_context"> -void <code class="descname">krb5_free_context</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_context" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_context"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_context</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="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_context" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>context</strong> - Library context</td> -</tr> -</tbody> -</table> -<p>This function frees a <em>context</em> that was created by <a class="reference internal" href="krb5_init_context.html#c.krb5_init_context" title="krb5_init_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_context()</span></code></a> or <a class="reference internal" href="krb5_init_secure_context.html#c.krb5_init_secure_context" title="krb5_init_secure_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_secure_context()</span></code></a> .</p> -</div> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p> +</dd> +</dl> +<p>This function frees a <em>context</em> that was created by krb5_init_context() or krb5_init_secure_context().</p> +</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_free_context - Free a krb5 library context.</a></li> @@ -128,6 +118,7 @@ void <code class="descname">krb5_free_context</code><span class="sig-paren">(</s <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -135,8 +126,8 @@ void <code class="descname">krb5_free_context</code><span class="sig-paren">(</s <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -144,7 +135,7 @@ void <code class="descname">krb5_free_context</code><span class="sig-paren">(</s >Contents</a> | <a href="krb5_expand_hostname.html" title="krb5_expand_hostname - Canonicalize a hostname, possibly using name service." >previous</a> | - <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message() ." + <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_free_cred_contents.html b/doc/html/appdev/refs/api/krb5_free_cred_contents.html index 16afaec31c63..181d6d4f40bc 100644 --- a/doc/html/appdev/refs/api/krb5_free_cred_contents.html +++ b/doc/html/appdev/refs/api/krb5_free_cred_contents.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_free_cred_contents - Free the contents of a krb5_creds structure. — 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_free_creds - Free a krb5_creds structure." href="krb5_free_creds.html" /> <link rel="prev" title="krb5_free_authenticator - Free a krb5_authenticator structure." href="krb5_free_authenticator.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-cred-contents-free-the-contents-of-a-krb5-creds-structure"> + <section id="krb5-free-cred-contents-free-the-contents-of-a-krb5-creds-structure"> <h1>krb5_free_cred_contents - Free the contents of a krb5_creds structure.<a class="headerlink" href="#krb5-free-cred-contents-free-the-contents-of-a-krb5-creds-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_cred_contents"> -void <code class="descname">krb5_free_cred_contents</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_cred_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_cred_contents"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_cred_contents</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_cred_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Credential structure to free contents of</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Credential structure to free contents of</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> , but not the structure itself.</p> -</div> +</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_free_cred_contents - Free the contents of a krb5_creds structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_cred_contents</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_cred_contents</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_creds.html b/doc/html/appdev/refs/api/krb5_free_creds.html index 8cba25e92244..521beb0d05f9 100644 --- a/doc/html/appdev/refs/api/krb5_free_creds.html +++ b/doc/html/appdev/refs/api/krb5_free_creds.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_free_creds - Free a krb5_creds structure. — 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_free_data - Free a krb5_data structure." href="krb5_free_data.html" /> <link rel="prev" title="krb5_free_cred_contents - Free the contents of a krb5_creds structure." href="krb5_free_cred_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-creds-free-a-krb5-creds-structure"> + <section id="krb5-free-creds-free-a-krb5-creds-structure"> <h1>krb5_free_creds - Free a krb5_creds structure.<a class="headerlink" href="#krb5-free-creds-free-a-krb5-creds-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_creds"> -void <code class="descname">krb5_free_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_creds"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Credential structure to be freed.</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Credential structure to be freed.</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_creds - Free a krb5_creds structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_creds</code><span class="sig-paren">(</spa <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_creds</code><span class="sig-paren">(</spa <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_data.html b/doc/html/appdev/refs/api/krb5_free_data.html index 055c577e5227..341bd1ab4b76 100644 --- a/doc/html/appdev/refs/api/krb5_free_data.html +++ b/doc/html/appdev/refs/api/krb5_free_data.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_free_data - Free a krb5_data structure. — 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_free_data_contents - Free the contents of a krb5_data structure and zero the data field." href="krb5_free_data_contents.html" /> <link rel="prev" title="krb5_free_creds - Free a krb5_creds structure." href="krb5_free_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-data-free-a-krb5-data-structure"> + <section id="krb5-free-data-free-a-krb5-data-structure"> <h1>krb5_free_data - Free a krb5_data structure.<a class="headerlink" href="#krb5-free-data-free-a-krb5-data-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_data"> -void <code class="descname">krb5_free_data</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_data" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_data"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_data</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>, <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">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_data" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Data structure to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Data structure to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_data - Free a krb5_data structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_data</code><span class="sig-paren">(</span <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_data</code><span class="sig-paren">(</span <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_data_contents.html b/doc/html/appdev/refs/api/krb5_free_data_contents.html index 03e4d9d61e5d..dbb44185d0d1 100644 --- a/doc/html/appdev/refs/api/krb5_free_data_contents.html +++ b/doc/html/appdev/refs/api/krb5_free_data_contents.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_free_data_contents - Free the contents of a krb5_data structure and zero the data field. — 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_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." href="krb5_free_default_realm.html" /> + <link rel="next" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." href="krb5_free_default_realm.html" /> <link rel="prev" title="krb5_free_data - Free a krb5_data structure." href="krb5_free_data.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,7 +33,7 @@ accesskey="C">Contents</a> | <a href="krb5_free_data.html" title="krb5_free_data - Free a krb5_data structure." accesskey="P">previous</a> | - <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." + <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-data-contents-free-the-contents-of-a-krb5-data-structure-and-zero-the-data-field"> + <section id="krb5-free-data-contents-free-the-contents-of-a-krb5-data-structure-and-zero-the-data-field"> <h1>krb5_free_data_contents - Free the contents of a krb5_data structure and zero the data field.<a class="headerlink" href="#krb5-free-data-contents-free-the-contents-of-a-krb5-data-structure-and-zero-the-data-field" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_data_contents"> -void <code class="descname">krb5_free_data_contents</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_data_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_data_contents"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_data_contents</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>, <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">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_data_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Data structure to free contents of</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Data structure to free contents of</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> , but not the structure itself. It sets the structure’s data pointer to null and (beginning in release 1.19) sets its length to zero.</p> -</div> +</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_free_data_contents - Free the contents of a krb5_data structure and zero the data field.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_data_contents</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_data_contents</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -146,7 +136,7 @@ void <code class="descname">krb5_free_data_contents</code><span class="sig-paren >Contents</a> | <a href="krb5_free_data.html" title="krb5_free_data - Free a krb5_data structure." >previous</a> | - <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." + <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_free_default_realm.html b/doc/html/appdev/refs/api/krb5_free_default_realm.html index aa68bdb33cea..f2ebf4a8c8c3 100644 --- a/doc/html/appdev/refs/api/krb5_free_default_realm.html +++ b/doc/html/appdev/refs/api/krb5_free_default_realm.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" /> - <title>krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() . — 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> + <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_free_default_realm - Free a default realm string returned by krb5_get_default_realm(). — MIT Kerberos Documentation</title> + <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_free_enctypes - Free an array of encryption types." href="krb5_free_enctypes.html" /> <link rel="prev" title="krb5_free_data_contents - Free the contents of a krb5_data structure and zero the data field." href="krb5_free_data_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm().">feedback</a> </div> </div> </div> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-default-realm-free-a-default-realm-string-returned-by-krb5-get-default-realm"> -<h1>krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() .<a class="headerlink" href="#krb5-free-default-realm-free-a-default-realm-string-returned-by-krb5-get-default-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_default_realm"> -void <code class="descname">krb5_free_default_realm</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>, char *<em> lrealm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_default_realm" title="Permalink to this definition">¶</a></dt> + <section id="krb5-free-default-realm-free-a-default-realm-string-returned-by-krb5-get-default-realm"> +<h1>krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm().<a class="headerlink" href="#krb5-free-default-realm-free-a-default-realm-string-returned-by-krb5-get-default-realm" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_default_realm"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_default_realm</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">lrealm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_default_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>lrealm</strong> - Realm to be freed</p> -</td> -</tr> -</tbody> -</table> -</div> +<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>lrealm</strong> - Realm to be freed</p> +</dd> +</dl> +</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_free_default_realm - Free a default realm string returned by krb5_get_default_realm() .</a></li> +<li><a class="reference internal" href="#">krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm().</a></li> </ul> <br/> @@ -129,6 +118,7 @@ void <code class="descname">krb5_free_default_realm</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_free_default_realm</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -151,7 +141,7 @@ void <code class="descname">krb5_free_default_realm</code><span class="sig-paren >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_free_enctypes.html b/doc/html/appdev/refs/api/krb5_free_enctypes.html index c8eed9f29a90..3a8ffe2552a5 100644 --- a/doc/html/appdev/refs/api/krb5_free_enctypes.html +++ b/doc/html/appdev/refs/api/krb5_free_enctypes.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_free_enctypes - Free an array of encryption types. — 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_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." href="krb5_free_error.html" /> - <link rel="prev" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." href="krb5_free_default_realm.html" /> - </head> - <body> + <link rel="next" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." href="krb5_free_error.html" /> + <link rel="prev" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." href="krb5_free_default_realm.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,9 +31,9 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." + <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." accesskey="P">previous</a> | - <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." + <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-enctypes-free-an-array-of-encryption-types"> + <section id="krb5-free-enctypes-free-an-array-of-encryption-types"> <h1>krb5_free_enctypes - Free an array of encryption types.<a class="headerlink" href="#krb5-free-enctypes-free-an-array-of-encryption-types" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_enctypes"> -void <code class="descname">krb5_free_enctypes</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_enctypes" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_enctypes"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_enctypes</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_enctypes" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Array of enctypes to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Array of enctypes to be freed</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.12</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.12</p> </div> +</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_free_enctypes - Free an array of encryption types.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_free_enctypes</code><span class="sig-paren">(</ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,16 +130,16 @@ void <code class="descname">krb5_free_enctypes</code><span class="sig-paren">(</ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm() ." + <a href="krb5_free_default_realm.html" title="krb5_free_default_realm - Free a default realm string returned by krb5_get_default_realm()." >previous</a> | - <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." + <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_free_error.html b/doc/html/appdev/refs/api/krb5_free_error.html index 07f4b90d98ff..321051e3b9e8 100644 --- a/doc/html/appdev/refs/api/krb5_free_error.html +++ b/doc/html/appdev/refs/api/krb5_free_error.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" /> - <title>krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() . — 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> + <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_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth(). — MIT Kerberos Documentation</title> + <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_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." href="krb5_free_host_realm.html" /> + <link rel="next" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." href="krb5_free_host_realm.html" /> <link rel="prev" title="krb5_free_enctypes - Free an array of encryption types." href="krb5_free_enctypes.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,13 +33,13 @@ accesskey="C">Contents</a> | <a href="krb5_free_enctypes.html" title="krb5_free_enctypes - Free an array of encryption types." accesskey="P">previous</a> | - <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." + <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth().">feedback</a> </div> </div> </div> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-error-free-an-error-allocated-by-krb5-read-error-or-krb5-sendauth"> -<h1>krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() .<a class="headerlink" href="#krb5-free-error-free-an-error-allocated-by-krb5-read-error-or-krb5-sendauth" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_error"> -void <code class="descname">krb5_free_error</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>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_error" title="Permalink to this definition">¶</a></dt> + <section id="krb5-free-error-free-an-error-allocated-by-krb5-read-error-or-krb5-sendauth"> +<h1>krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth().<a class="headerlink" href="#krb5-free-error-free-an-error-allocated-by-krb5-read-error-or-krb5-sendauth" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_error"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_error</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>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_error" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Error data structure to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Error data structure to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() .</a></li> +<li><a class="reference internal" href="#">krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth().</a></li> </ul> <br/> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_error</code><span class="sig-paren">(</spa <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_error</code><span class="sig-paren">(</spa <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -146,13 +136,13 @@ void <code class="descname">krb5_free_error</code><span class="sig-paren">(</spa >Contents</a> | <a href="krb5_free_enctypes.html" title="krb5_free_enctypes - Free an array of encryption types." >previous</a> | - <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." + <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_free_error_message.html b/doc/html/appdev/refs/api/krb5_free_error_message.html index c0d1d17328d4..010c0e38e6e9 100644 --- a/doc/html/appdev/refs/api/krb5_free_error_message.html +++ b/doc/html/appdev/refs/api/krb5_free_error_message.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" /> - <title>krb5_free_error_message - Free an error message generated by krb5_get_error_message() . — 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> + <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_free_error_message - Free an error message generated by krb5_get_error_message(). — MIT Kerberos Documentation</title> + <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_free_principal - Free the storage assigned to a principal." href="krb5_free_principal.html" /> <link rel="prev" title="krb5_free_context - Free a krb5 library context." href="krb5_free_context.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error_message - Free an error message generated by krb5_get_error_message() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error_message - Free an error message generated by krb5_get_error_message().">feedback</a> </div> </div> </div> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-error-message-free-an-error-message-generated-by-krb5-get-error-message"> -<h1>krb5_free_error_message - Free an error message generated by krb5_get_error_message() .<a class="headerlink" href="#krb5-free-error-message-free-an-error-message-generated-by-krb5-get-error-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_error_message"> -void <code class="descname">krb5_free_error_message</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> ctx</em>, const char *<em> msg</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_error_message" title="Permalink to this definition">¶</a></dt> + <section id="krb5-free-error-message-free-an-error-message-generated-by-krb5-get-error-message"> +<h1>krb5_free_error_message - Free an error message generated by krb5_get_error_message().<a class="headerlink" href="#krb5-free-error-message-free-an-error-message-generated-by-krb5-get-error-message" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_error_message</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">ctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">msg</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> -<p class="last"><strong>[in]</strong> <strong>msg</strong> - Pointer to error message</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> +<p><strong>[in]</strong> <strong>msg</strong> - Pointer to error message</p> +</dd> +</dl> +</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_free_error_message - Free an error message generated by krb5_get_error_message() .</a></li> +<li><a class="reference internal" href="#">krb5_free_error_message - Free an error message generated by krb5_get_error_message().</a></li> </ul> <br/> @@ -129,6 +118,7 @@ void <code class="descname">krb5_free_error_message</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_free_error_message</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -151,7 +141,7 @@ void <code class="descname">krb5_free_error_message</code><span class="sig-paren >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error_message - Free an error message generated by krb5_get_error_message() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_error_message - Free an error message generated by krb5_get_error_message().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_free_host_realm.html b/doc/html/appdev/refs/api/krb5_free_host_realm.html index b56139a6bb91..b095c77c9441 100644 --- a/doc/html/appdev/refs/api/krb5_free_host_realm.html +++ b/doc/html/appdev/refs/api/krb5_free_host_realm.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" /> - <title>krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() . — 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> + <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_free_host_realm - Free the memory allocated by krb5_get_host_realm(). — MIT Kerberos Documentation</title> + <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_free_keyblock - Free a krb5_keyblock structure." href="krb5_free_keyblock.html" /> - <link rel="prev" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." href="krb5_free_error.html" /> - </head> - <body> + <link rel="prev" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." href="krb5_free_error.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." + <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." accesskey="P">previous</a> | <a href="krb5_free_keyblock.html" title="krb5_free_keyblock - Free a krb5_keyblock structure." accesskey="N">next</a> | @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm().">feedback</a> </div> </div> </div> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-host-realm-free-the-memory-allocated-by-krb5-get-host-realm"> -<h1>krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() .<a class="headerlink" href="#krb5-free-host-realm-free-the-memory-allocated-by-krb5-get-host-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_host_realm"> -<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_free_host_realm</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>, char *const *<em> realmlist</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_host_realm" title="Permalink to this definition">¶</a></dt> + <section id="krb5-free-host-realm-free-the-memory-allocated-by-krb5-get-host-realm"> +<h1>krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm().<a class="headerlink" href="#krb5-free-host-realm-free-the-memory-allocated-by-krb5-get-host-realm" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_host_realm"> +<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_free_host_realm</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realmlist</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_host_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>realmlist</strong> - List of realm names to be released</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 simple"> -<li>0 Success</li> +<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>realmlist</strong> - List of realm names to be released</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_free_host_realm - Free the memory allocated by krb5_get_host_realm() .</a></li> +<li><a class="reference internal" href="#">krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm().</a></li> </ul> <br/> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,14 +138,14 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth() ." + <a href="krb5_free_error.html" title="krb5_free_error - Free an error allocated by krb5_read_error() or krb5_sendauth()." >previous</a> | <a href="krb5_free_keyblock.html" title="krb5_free_keyblock - Free a krb5_keyblock structure." >next</a> | @@ -167,7 +153,7 @@ >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_free_keyblock.html b/doc/html/appdev/refs/api/krb5_free_keyblock.html index c47590124964..8a0a83f54f42 100644 --- a/doc/html/appdev/refs/api/krb5_free_keyblock.html +++ b/doc/html/appdev/refs/api/krb5_free_keyblock.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_free_keyblock - Free a krb5_keyblock structure. — 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_free_keyblock_contents - Free the contents of a krb5_keyblock structure." href="krb5_free_keyblock_contents.html" /> - <link rel="prev" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." href="krb5_free_host_realm.html" /> - </head> - <body> + <link rel="prev" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." href="krb5_free_host_realm.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." + <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." accesskey="P">previous</a> | <a href="krb5_free_keyblock_contents.html" title="krb5_free_keyblock_contents - Free the contents of a krb5_keyblock structure." accesskey="N">next</a> | @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-keyblock-free-a-krb5-keyblock-structure"> + <section id="krb5-free-keyblock-free-a-krb5-keyblock-structure"> <h1>krb5_free_keyblock - Free a krb5_keyblock structure.<a class="headerlink" href="#krb5-free-keyblock-free-a-krb5-keyblock-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_keyblock"> -void <code class="descname">krb5_free_keyblock</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>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keyblock" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_keyblock"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_keyblock</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>, <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">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keyblock" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Keyblock to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Keyblock to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_keyblock - Free a krb5_keyblock structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_keyblock</code><span class="sig-paren">(</ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,14 +127,14 @@ void <code class="descname">krb5_free_keyblock</code><span class="sig-paren">(</ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm() ." + <a href="krb5_free_host_realm.html" title="krb5_free_host_realm - Free the memory allocated by krb5_get_host_realm()." >previous</a> | <a href="krb5_free_keyblock_contents.html" title="krb5_free_keyblock_contents - Free the contents of a krb5_keyblock structure." >next</a> | diff --git a/doc/html/appdev/refs/api/krb5_free_keyblock_contents.html b/doc/html/appdev/refs/api/krb5_free_keyblock_contents.html index 3bd64d28f298..1e477ec93a79 100644 --- a/doc/html/appdev/refs/api/krb5_free_keyblock_contents.html +++ b/doc/html/appdev/refs/api/krb5_free_keyblock_contents.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_free_keyblock_contents - Free the contents of a krb5_keyblock structure. — 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_free_keytab_entry_contents - Free the contents of a key table entry." href="krb5_free_keytab_entry_contents.html" /> <link rel="prev" title="krb5_free_keyblock - Free a krb5_keyblock structure." href="krb5_free_keyblock.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-keyblock-contents-free-the-contents-of-a-krb5-keyblock-structure"> + <section id="krb5-free-keyblock-contents-free-the-contents-of-a-krb5-keyblock-structure"> <h1>krb5_free_keyblock_contents - Free the contents of a krb5_keyblock structure.<a class="headerlink" href="#krb5-free-keyblock-contents-free-the-contents-of-a-krb5-keyblock-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_keyblock_contents"> -void <code class="descname">krb5_free_keyblock_contents</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>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keyblock_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_keyblock_contents"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_keyblock_contents</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>, <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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keyblock_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>key</strong> - Keyblock to be freed</p> -</td> -</tr> -</tbody> -</table> +<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> - Keyblock to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>key</em> , but not the structure itself.</p> -</div> +</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_free_keyblock_contents - Free the contents of a krb5_keyblock structure.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_keyblock_contents</code><span class="sig-p <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_keyblock_contents</code><span class="sig-p <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_keytab_entry_contents.html b/doc/html/appdev/refs/api/krb5_free_keytab_entry_contents.html index d2324f8835a3..ca780f4ee30a 100644 --- a/doc/html/appdev/refs/api/krb5_free_keytab_entry_contents.html +++ b/doc/html/appdev/refs/api/krb5_free_keytab_entry_contents.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_free_keytab_entry_contents - Free the contents of a key table entry. — 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_free_string - Free a string allocated by a krb5 function." href="krb5_free_string.html" /> <link rel="prev" title="krb5_free_keyblock_contents - Free the contents of a krb5_keyblock structure." href="krb5_free_keyblock_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-keytab-entry-contents-free-the-contents-of-a-key-table-entry"> + <section id="krb5-free-keytab-entry-contents-free-the-contents-of-a-key-table-entry"> <h1>krb5_free_keytab_entry_contents - Free the contents of a key table entry.<a class="headerlink" href="#krb5-free-keytab-entry-contents-free-the-contents-of-a-key-table-entry" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_keytab_entry_contents"> -<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_free_keytab_entry_contents</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>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keytab_entry_contents" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_keytab_entry_contents"> +<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_free_keytab_entry_contents</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>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_keytab_entry_contents" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>entry</strong> - Key table entry whose contents are to be freed</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> +<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>entry</strong> - Key table entry whose contents are to be freed</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> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The pointer is not freed.</p> -</div> +<p class="admonition-title">Note</p> +<p>The pointer is not freed.</p> </div> +</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_free_keytab_entry_contents - Free the contents of a key table entry.</a></li> @@ -144,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_principal.html b/doc/html/appdev/refs/api/krb5_free_principal.html index 8ce20ba51ad7..496366a43133 100644 --- a/doc/html/appdev/refs/api/krb5_free_principal.html +++ b/doc/html/appdev/refs/api/krb5_free_principal.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_free_principal - Free the storage assigned to a principal. — 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_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message." href="krb5_fwd_tgt_creds.html" /> - <link rel="prev" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message() ." href="krb5_free_error_message.html" /> - </head> - <body> + <link rel="prev" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." href="krb5_free_error_message.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message() ." + <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." accesskey="P">previous</a> | <a href="krb5_fwd_tgt_creds.html" title="krb5_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message." accesskey="N">next</a> | @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-principal-free-the-storage-assigned-to-a-principal"> + <section id="krb5-free-principal-free-the-storage-assigned-to-a-principal"> <h1>krb5_free_principal - Free the storage assigned to a principal.<a class="headerlink" href="#krb5-free-principal-free-the-storage-assigned-to-a-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_principal"> -void <code class="descname">krb5_free_principal</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_principal"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_principal</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Principal to be freed</p> -</td> -</tr> -</tbody> -</table> -</div> +<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>val</strong> - Principal to be freed</p> +</dd> +</dl> +</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_free_principal - Free the storage assigned to a principal.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_free_principal</code><span class="sig-paren">(< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,14 +126,14 @@ void <code class="descname">krb5_free_principal</code><span class="sig-paren">(< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message() ." + <a href="krb5_free_error_message.html" title="krb5_free_error_message - Free an error message generated by krb5_get_error_message()." >previous</a> | <a href="krb5_fwd_tgt_creds.html" title="krb5_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message." >next</a> | diff --git a/doc/html/appdev/refs/api/krb5_free_string.html b/doc/html/appdev/refs/api/krb5_free_string.html index 2a93105aa753..c02087a4a606 100644 --- a/doc/html/appdev/refs/api/krb5_free_string.html +++ b/doc/html/appdev/refs/api/krb5_free_string.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_free_string - Free a string allocated by a krb5 function. — 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_free_ticket - Free a ticket." href="krb5_free_ticket.html" /> <link rel="prev" title="krb5_free_keytab_entry_contents - Free the contents of a key table entry." href="krb5_free_keytab_entry_contents.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-string-free-a-string-allocated-by-a-krb5-function"> + <section id="krb5-free-string-free-a-string-allocated-by-a-krb5-function"> <h1>krb5_free_string - Free a string allocated by a krb5 function.<a class="headerlink" href="#krb5-free-string-free-a-string-allocated-by-a-krb5-function" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_string"> -void <code class="descname">krb5_free_string</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>, char *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_string"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_string</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - String to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - String to be freed</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.10</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.10</p> </div> +</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_free_string - Free a string allocated by a krb5 function.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_free_string</code><span class="sig-paren">(</sp <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ void <code class="descname">krb5_free_string</code><span class="sig-paren">(</sp <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_tgt_creds.html b/doc/html/appdev/refs/api/krb5_free_tgt_creds.html index 4cc2c6a6c908..f90279405540 100644 --- a/doc/html/appdev/refs/api/krb5_free_tgt_creds.html +++ b/doc/html/appdev/refs/api/krb5_free_tgt_creds.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_free_tgt_creds - Free an array of credential structures. — 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_k_create_key - Create a krb5_key from the enctype and key data in a keyblock." href="krb5_k_create_key.html" /> <link rel="prev" title="krb5_free_cksumtypes - Free an array of checksum types." href="krb5_free_cksumtypes.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-tgt-creds-free-an-array-of-credential-structures"> + <section id="krb5-free-tgt-creds-free-an-array-of-credential-structures"> <h1>krb5_free_tgt_creds - Free an array of credential structures.<a class="headerlink" href="#krb5-free-tgt-creds-free-an-array-of-credential-structures" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_tgt_creds"> -void <code class="descname">krb5_free_tgt_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> tgts</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_tgt_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_tgt_creds"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_tgt_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">tgts</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_tgt_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>tgts</strong> - Null-terminated array of credentials to free</p> -</td> -</tr> -</tbody> -</table> +<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>tgts</strong> - Null-terminated array of credentials to free</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The last entry in the array <em>tgts</em> must be a NULL pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>The last entry in the array <em>tgts</em> must be a NULL pointer.</p> </div> +</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_free_tgt_creds - Free an array of credential structures.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_free_tgt_creds</code><span class="sig-paren">(< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ void <code class="descname">krb5_free_tgt_creds</code><span class="sig-paren">(< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_ticket.html b/doc/html/appdev/refs/api/krb5_free_ticket.html index 483ed326d3e4..3e022993ef77 100644 --- a/doc/html/appdev/refs/api/krb5_free_ticket.html +++ b/doc/html/appdev/refs/api/krb5_free_ticket.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_free_ticket - Free a ticket. — 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_free_unparsed_name - Free a string representation of a principal." href="krb5_free_unparsed_name.html" /> <link rel="prev" title="krb5_free_string - Free a string allocated by a krb5 function." href="krb5_free_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-ticket-free-a-ticket"> + <section id="krb5-free-ticket-free-a-ticket"> <h1>krb5_free_ticket - Free a ticket.<a class="headerlink" href="#krb5-free-ticket-free-a-ticket" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_ticket"> -void <code class="descname">krb5_free_ticket</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>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_ticket" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_ticket"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_ticket</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>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_ticket" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Ticket to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>val</strong> - Ticket to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>val</em> and the structure itself.</p> -</div> +</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_free_ticket - Free a ticket.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_free_ticket</code><span class="sig-paren">(</sp <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_free_ticket</code><span class="sig-paren">(</sp <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_free_unparsed_name.html b/doc/html/appdev/refs/api/krb5_free_unparsed_name.html index 054148497d8e..a6faa009dc07 100644 --- a/doc/html/appdev/refs/api/krb5_free_unparsed_name.html +++ b/doc/html/appdev/refs/api/krb5_free_unparsed_name.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_free_unparsed_name - Free a string representation of a principal. — 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_get_etype_info - Retrieve enctype, salt and s2kparams from KDC." href="krb5_get_etype_info.html" /> <link rel="prev" title="krb5_free_ticket - Free a ticket." href="krb5_free_ticket.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-free-unparsed-name-free-a-string-representation-of-a-principal"> + <section id="krb5-free-unparsed-name-free-a-string-representation-of-a-principal"> <h1>krb5_free_unparsed_name - Free a string representation of a principal.<a class="headerlink" href="#krb5-free-unparsed-name-free-a-string-representation-of-a-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_free_unparsed_name"> -void <code class="descname">krb5_free_unparsed_name</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>, char *<em> val</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_unparsed_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_free_unparsed_name"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_free_unparsed_name</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">val</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_free_unparsed_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>val</strong> - Name string to be freed</p> -</td> -</tr> -</tbody> -</table> -</div> +<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>val</strong> - Name string to be freed</p> +</dd> +</dl> +</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_free_unparsed_name - Free a string representation of a principal.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_free_unparsed_name</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_free_unparsed_name</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_fwd_tgt_creds.html b/doc/html/appdev/refs/api/krb5_fwd_tgt_creds.html index eba2c9023d5f..16429b1bc8b7 100644 --- a/doc/html/appdev/refs/api/krb5_fwd_tgt_creds.html +++ b/doc/html/appdev/refs/api/krb5_fwd_tgt_creds.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_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message. — 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_get_default_realm - Retrieve the default realm." href="krb5_get_default_realm.html" /> <link rel="prev" title="krb5_free_principal - Free the storage assigned to a principal." href="krb5_free_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,58 +52,52 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-fwd-tgt-creds-get-a-forwarded-tgt-and-format-a-krb-cred-message"> + <section id="krb5-fwd-tgt-creds-get-a-forwarded-tgt-and-format-a-krb-cred-message"> <h1>krb5_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message.<a class="headerlink" href="#krb5-fwd-tgt-creds-get-a-forwarded-tgt-and-format-a-krb-cred-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_fwd_tgt_creds"> -<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_fwd_tgt_creds</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const char *<em> rhost</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> cc</em>, int<em> forwardable</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_fwd_tgt_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_fwd_tgt_creds"> +<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_fwd_tgt_creds</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rhost</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">cc</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">forwardable</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">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_fwd_tgt_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>rhost</strong> - Remote host</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal of TGT</p> <p><strong>[in]</strong> <strong>server</strong> - Principal of server to receive TGT</p> <p><strong>[in]</strong> <strong>cc</strong> - Credential cache handle (NULL to use default)</p> <p><strong>[in]</strong> <strong>forwardable</strong> - Whether TGT should be forwardable</p> -<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - KRB-CRED message</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 simple"> -<li>0 Success</li> -<li>ENOMEM Insufficient memory</li> -<li>KRB5_PRINC_NOMATCH Requested principal and ticket do not match</li> -<li>KRB5_NO_TKT_SUPPLIED Request did not supply a ticket</li> -<li>KRB5_CC_BADNAME Credential cache name or principal name malformed</li> +<p><strong>[out]</strong> <strong>outbuf</strong> - KRB-CRED message</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</p></li> +<li><p>ENOMEM Insufficient memory</p></li> +<li><p>KRB5_PRINC_NOMATCH Requested principal and ticket do not match</p></li> +<li><p>KRB5_NO_TKT_SUPPLIED Request did not supply a ticket</p></li> +<li><p>KRB5_CC_BADNAME Credential cache name or principal name malformed</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Get a TGT for use at the remote host <em>rhost</em> and format it into a KRB-CRED message. If <em>rhost</em> is NULL and <em>server</em> is of type <a class="reference internal" href="../macros/KRB5_NT_SRV_HST.html#KRB5_NT_SRV_HST" title="KRB5_NT_SRV_HST"><code class="xref py py-data docutils literal"><span class="pre">KRB5_NT_SRV_HST</span></code></a> , the second component of <em>server</em> will be used.</p> -</div> +</dd> +</dl> +<p>Get a TGT for use at the remote host <em>rhost</em> and format it into a KRB-CRED message. If <em>rhost</em> is NULL and <em>server</em> is of type #KRB5_NT_SRV_HST, the second component of <em>server</em> will be used.</p> +</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_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message.</a></li> @@ -156,6 +141,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -163,8 +149,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_credentials.html b/doc/html/appdev/refs/api/krb5_get_credentials.html index ef276ed649ae..bb68b8f9fd9b 100644 --- a/doc/html/appdev/refs/api/krb5_get_credentials.html +++ b/doc/html/appdev/refs/api/krb5_get_credentials.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_get_credentials - Get an additional ticket. — 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_get_fallback_host_realm" href="krb5_get_fallback_host_realm.html" /> <link rel="prev" title="krb5_get_host_realm - Get the Kerberos realm names for a host." href="krb5_get_host_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,64 +52,58 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-credentials-get-an-additional-ticket"> + <section id="krb5-get-credentials-get-an-additional-ticket"> <h1>krb5_get_credentials - Get an additional ticket.<a class="headerlink" href="#krb5-get-credentials-get-an-additional-ticket" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_credentials"> -<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_get_credentials</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> out_creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_credentials"> +<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_get_credentials</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>options</strong> - Options</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>in_creds</strong> - Input credentials</p> -<p class="last"><strong>[out]</strong> <strong>out_creds</strong> - Output updated credentials</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>out_creds</strong> - Output updated credentials</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Use <em>ccache</em> or a TGS exchange to get a service ticket matching <em>in_creds</em> .</p> <p>Valid values for <em>options</em> are:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_GC_CACHED.html#KRB5_GC_CACHED" title="KRB5_GC_CACHED"><code class="xref py py-data docutils literal"><span class="pre">KRB5_GC_CACHED</span></code></a> Search only credential cache for the ticket</li> -<li><a class="reference internal" href="../macros/KRB5_GC_USER_USER.html#KRB5_GC_USER_USER" title="KRB5_GC_USER_USER"><code class="xref py py-data docutils literal"><span class="pre">KRB5_GC_USER_USER</span></code></a> Return a user to user authentication ticket</li> +<li><p>#KRB5_GC_CACHED Search only credential cache for the ticket</p></li> +<li><p>#KRB5_GC_USER_USER Return a user to user authentication ticket</p></li> </ul> </div></blockquote> <p><em>in_creds</em> must be non-null. <em>in_creds->client</em> and <em>in_creds->server</em> must be filled in to specify the client and the server respectively. If any authorization data needs to be requested for the service ticket (such as restrictions on how the ticket can be used), specify it in <em>in_creds->authdata</em> ; otherwise set <em>in_creds->authdata</em> to NULL. The session key type is specified in <em>in_creds->keyblock.enctype</em> , if it is nonzero.</p> </div></blockquote> <p>The expiration date is specified in <em>in_creds->times.endtime</em> . The KDC may return tickets with an earlier expiration date. If <em>in_creds->times.endtime</em> is set to 0, the latest possible expiration date will be requested.</p> <p>Any returned ticket and intermediate ticket-granting tickets are stored in <em>ccache</em> .</p> -<p>Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></code></a> to free <em>out_creds</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_creds() to free <em>out_creds</em> when it is no longer needed.</p> +</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_get_credentials - Get an additional ticket.</a></li> @@ -162,6 +147,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -169,8 +155,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_credentials_renew.html b/doc/html/appdev/refs/api/krb5_get_credentials_renew.html index f5ca58d029b6..930f2fadae2a 100644 --- a/doc/html/appdev/refs/api/krb5_get_credentials_renew.html +++ b/doc/html/appdev/refs/api/krb5_get_credentials_renew.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_get_credentials_renew — 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_get_credentials_validate" href="krb5_get_credentials_validate.html" /> <link rel="prev" title="krb5_cc_gen_new" href="krb5_cc_gen_new.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-credentials-renew"> + <section id="krb5-get-credentials-renew"> <h1>krb5_get_credentials_renew<a class="headerlink" href="#krb5-get-credentials-renew" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_credentials_renew"> -<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_get_credentials_renew</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> out_creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials_renew" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_credentials_renew"> +<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_get_credentials_renew</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials_renew" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>options</strong></p> <p><strong>ccache</strong></p> <p><strong>in_creds</strong></p> -<p class="last"><strong>out_creds</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>out_creds</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_get_renewed_creds.</p> -</div> +</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_get_credentials_renew</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_credentials_validate.html b/doc/html/appdev/refs/api/krb5_get_credentials_validate.html index f0e665df6b1d..6b2ded9f4a38 100644 --- a/doc/html/appdev/refs/api/krb5_get_credentials_validate.html +++ b/doc/html/appdev/refs/api/krb5_get_credentials_validate.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_get_credentials_validate — 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_get_in_tkt_with_password" href="krb5_get_in_tkt_with_password.html" /> <link rel="prev" title="krb5_get_credentials_renew" href="krb5_get_credentials_renew.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-credentials-validate"> + <section id="krb5-get-credentials-validate"> <h1>krb5_get_credentials_validate<a class="headerlink" href="#krb5-get-credentials-validate" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_credentials_validate"> -<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_get_credentials_validate</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> out_creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials_validate" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_credentials_validate"> +<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_get_credentials_validate</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_credentials_validate" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>options</strong></p> <p><strong>ccache</strong></p> <p><strong>in_creds</strong></p> -<p class="last"><strong>out_creds</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>out_creds</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_get_validated_creds.</p> -</div> +</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_get_credentials_validate</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_default_realm.html b/doc/html/appdev/refs/api/krb5_get_default_realm.html index b543ea631cca..a9a6e85ee7c1 100644 --- a/doc/html/appdev/refs/api/krb5_get_default_realm.html +++ b/doc/html/appdev/refs/api/krb5_get_default_realm.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_get_default_realm - Retrieve the default realm. — 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_get_error_message - Get the (possibly extended) error message for a code." href="krb5_get_error_message.html" /> <link rel="prev" title="krb5_fwd_tgt_creds - Get a forwarded TGT and format a KRB-CRED message." href="krb5_fwd_tgt_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-default-realm-retrieve-the-default-realm"> + <section id="krb5-get-default-realm-retrieve-the-default-realm"> <h1>krb5_get_default_realm - Retrieve the default realm.<a class="headerlink" href="#krb5-get-default-realm-retrieve-the-default-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_default_realm"> -<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_get_default_realm</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>, char **<em> lrealm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_default_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_default_realm"> +<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_get_default_realm</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">lrealm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_default_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>lrealm</strong> - Default realm name</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 simple"> -<li>0 Success</li> +<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>[out]</strong> <strong>lrealm</strong> - Default realm name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Retrieves the default realm to be used if no user-specified realm is available.</p> -<p>Use <a class="reference internal" href="krb5_free_default_realm.html#c.krb5_free_default_realm" title="krb5_free_default_realm"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_default_realm()</span></code></a> to free <em>lrealm</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_default_realm() to free <em>lrealm</em> when it is no longer needed.</p> +</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_get_default_realm - Retrieve the default realm.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_error_message.html b/doc/html/appdev/refs/api/krb5_get_error_message.html index f29c1497e11e..8ec008004b72 100644 --- a/doc/html/appdev/refs/api/krb5_get_error_message.html +++ b/doc/html/appdev/refs/api/krb5_get_error_message.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_get_error_message - Get the (possibly extended) error message for a code. — 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_get_host_realm - Get the Kerberos realm names for a host." href="krb5_get_host_realm.html" /> <link rel="prev" title="krb5_get_default_realm - Retrieve the default realm." href="krb5_get_default_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,38 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-error-message-get-the-possibly-extended-error-message-for-a-code"> + <section id="krb5-get-error-message-get-the-possibly-extended-error-message-for-a-code"> <h1>krb5_get_error_message - Get the (possibly extended) error message for a code.<a class="headerlink" href="#krb5-get-error-message-get-the-possibly-extended-error-message-for-a-code" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_error_message"> -const char * <code class="descname">krb5_get_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_error_message"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_error_message</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">ctx</span></span>, <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="n"><span class="pre">code</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> -<p class="last"><strong>[in]</strong> <strong>code</strong> - Error code</p> -</td> -</tr> -</tbody> -</table> -<p>The behavior of <a class="reference internal" href="#c.krb5_get_error_message" title="krb5_get_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_error_message()</span></code></a> is only defined the first time it is called after a failed call to a krb5 function using the same context, and only when the error code passed in is the same as that returned by the krb5 function.</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> +<p><strong>[in]</strong> <strong>code</strong> - Error code</p> +</dd> +</dl> +<p>The behavior of krb5_get_error_message() is only defined the first time it is called after a failed call to a krb5 function using the same context, and only when the error code passed in is the same as that returned by the krb5 function.</p> <p>This function never returns NULL, so its result may be used unconditionally as a C string.</p> -<p>The string returned by this function must be freed using <a class="reference internal" href="krb5_free_error_message.html#c.krb5_free_error_message" title="krb5_free_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_error_message()</span></code></a></p> +<p>The string returned by this function must be freed using krb5_free_error_message()</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Future versions may return the same string for the second and following calls.</p> -</div> +<p class="admonition-title">Note</p> +<p>Future versions may return the same string for the second and following calls.</p> </div> +</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_get_error_message - Get the (possibly extended) error message for a code.</a></li> @@ -136,6 +125,7 @@ const char * <code class="descname">krb5_get_error_message</code><span class="si <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +133,8 @@ const char * <code class="descname">krb5_get_error_message</code><span class="si <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_etype_info.html b/doc/html/appdev/refs/api/krb5_get_etype_info.html index 51a523d75082..3cb660013e72 100644 --- a/doc/html/appdev/refs/api/krb5_get_etype_info.html +++ b/doc/html/appdev/refs/api/krb5_get_etype_info.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_get_etype_info - Retrieve enctype, salt and s2kparams from KDC. — 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_get_permitted_enctypes - Return a list of encryption types permitted for session keys." href="krb5_get_permitted_enctypes.html" /> <link rel="prev" title="krb5_free_unparsed_name - Free a string representation of a principal." href="krb5_free_unparsed_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,59 +52,54 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-etype-info-retrieve-enctype-salt-and-s2kparams-from-kdc"> + <section id="krb5-get-etype-info-retrieve-enctype-salt-and-s2kparams-from-kdc"> <h1>krb5_get_etype_info - Retrieve enctype, salt and s2kparams from KDC.<a class="headerlink" href="#krb5-get-etype-info-retrieve-enctype-salt-and-s2kparams-from-kdc" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_etype_info"> -<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_get_etype_info</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> principal</em>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> enctype_out</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> salt_out</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> s2kparams_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_etype_info" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_etype_info"> +<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_get_etype_info</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">enctype_out</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">salt_out</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">s2kparams_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_etype_info" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal whose information is requested</p> <p><strong>[in]</strong> <strong>opt</strong> - Initial credential options</p> <p><strong>[out]</strong> <strong>enctype_out</strong> - The enctype chosen by KDC</p> <p><strong>[out]</strong> <strong>salt_out</strong> - Salt returned from KDC</p> -<p class="last"><strong>[out]</strong> <strong>s2kparams_out</strong> - String-to-key parameters returned from KDC</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>s2kparams_out</strong> - String-to-key parameters returned from KDC</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>A Kerberos error code</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>A Kerberos error code</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Send an initial ticket request for <em>principal</em> and extract the encryption type, salt type, and string-to-key parameters from the KDC response. If the KDC provides no etype-info, set <em>enctype_out</em> to <strong>ENCTYPE_NULL</strong> and set <em>salt_out</em> and <em>s2kparams_out</em> to empty. If the KDC etype-info provides no salt, compute the default salt and place it in <em>salt_out</em> . If the KDC etype-info provides no string-to-key parameters, set <em>s2kparams_out</em> to empty.</p> <blockquote> -<div><em>opt</em> may be used to specify options which affect the initial request, such as request encryption types or a FAST armor cache (see <a class="reference internal" href="krb5_get_init_creds_opt_set_etype_list.html#c.krb5_get_init_creds_opt_set_etype_list" title="krb5_get_init_creds_opt_set_etype_list"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_etype_list()</span></code></a> and <a class="reference internal" href="krb5_get_init_creds_opt_set_fast_ccache_name.html#c.krb5_get_init_creds_opt_set_fast_ccache_name" title="krb5_get_init_creds_opt_set_fast_ccache_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_fast_ccache_name()</span></code></a> ).</div></blockquote> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>salt_out</em> and <em>s2kparams_out</em> when they are no longer needed.</p> +<div><p><em>opt</em> may be used to specify options which affect the initial request, such as request encryption types or a FAST armor cache (see krb5_get_init_creds_opt_set_etype_list() and krb5_get_init_creds_opt_set_fast_ccache_name()).</p> +</div></blockquote> +<p>Use krb5_free_data_contents() to free <em>salt_out</em> and <em>s2kparams_out</em> when they are no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.17</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.17</p> </div> +</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_get_etype_info - Retrieve enctype, salt and s2kparams from KDC.</a></li> @@ -157,6 +143,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -164,8 +151,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_fallback_host_realm.html b/doc/html/appdev/refs/api/krb5_get_fallback_host_realm.html index 2bda3cbdd2b9..41d978b72823 100644 --- a/doc/html/appdev/refs/api/krb5_get_fallback_host_realm.html +++ b/doc/html/appdev/refs/api/krb5_get_fallback_host_realm.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_get_fallback_host_realm — 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_get_init_creds_keytab - Get initial credentials using a key table." href="krb5_get_init_creds_keytab.html" /> <link rel="prev" title="krb5_get_credentials - Get an additional ticket." href="krb5_get_credentials.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-fallback-host-realm"> + <section id="krb5-get-fallback-host-realm"> <h1>krb5_get_fallback_host_realm<a class="headerlink" href="#krb5-get-fallback-host-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_fallback_host_realm"> -<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_get_fallback_host_realm</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>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> hdata</em>, char ***<em> realmsp</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_fallback_host_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_fallback_host_realm"> +<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_get_fallback_host_realm</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>, <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">hdata</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realmsp</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_fallback_host_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>hdata</strong> - Host name (or NULL)</p> -<p class="last"><strong>[out]</strong> <strong>realmsp</strong> - Null-terminated list of realm names</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>realmsp</strong> - Null-terminated list of realm names</p> +</dd> +</dl> <p>Fill in <em>realmsp</em> with a pointer to a null-terminated list of realm names obtained through heuristics or insecure resolution methods which have lower priority than KDC referrals.</p> <p>If <em>host</em> is NULL, the local host’s realms are determined.</p> -<p>Use <a class="reference internal" href="krb5_free_host_realm.html#c.krb5_free_host_realm" title="krb5_free_host_realm"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_host_realm()</span></code></a> to release <em>realmsp</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_host_realm() to release <em>realmsp</em> when it is no longer needed.</p> +</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_get_fallback_host_realm</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_host_realm.html b/doc/html/appdev/refs/api/krb5_get_host_realm.html index e1bca6a2a9f5..8594425c5384 100644 --- a/doc/html/appdev/refs/api/krb5_get_host_realm.html +++ b/doc/html/appdev/refs/api/krb5_get_host_realm.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_get_host_realm - Get the Kerberos realm names for a host. — 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_get_credentials - Get an additional ticket." href="krb5_get_credentials.html" /> <link rel="prev" title="krb5_get_error_message - Get the (possibly extended) error message for a code." href="krb5_get_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-host-realm-get-the-kerberos-realm-names-for-a-host"> + <section id="krb5-get-host-realm-get-the-kerberos-realm-names-for-a-host"> <h1>krb5_get_host_realm - Get the Kerberos realm names for a host.<a class="headerlink" href="#krb5-get-host-realm-get-the-kerberos-realm-names-for-a-host" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_host_realm"> -<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_get_host_realm</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 char *<em> host</em>, char ***<em> realmsp</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_host_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_host_realm"> +<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_get_host_realm</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">host</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realmsp</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_host_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>host</strong> - Host name (or NULL)</p> -<p class="last"><strong>[out]</strong> <strong>realmsp</strong> - Null-terminated list of realm names</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 simple"> -<li>0 Success</li> -<li>ENOMEM Insufficient memory</li> +<p><strong>[out]</strong> <strong>realmsp</strong> - Null-terminated list of realm names</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</p></li> +<li><p>ENOMEM Insufficient memory</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Fill in <em>realmsp</em> with a pointer to a null-terminated list of realm names. If there are no known realms for the host, a list containing the referral (empty) realm is returned.</p> <p>If <em>host</em> is NULL, the local host’s realms are determined.</p> -<p>Use <a class="reference internal" href="krb5_free_host_realm.html#c.krb5_free_host_realm" title="krb5_free_host_realm"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_host_realm()</span></code></a> to release <em>realmsp</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_host_realm() to release <em>realmsp</em> when it is no longer needed.</p> +</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_get_host_realm - Get the Kerberos realm names for a host.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_keytab.html b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_keytab.html index 30406bba1e53..d546b065b531 100644 --- a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_keytab.html +++ b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_keytab.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_get_in_tkt_with_keytab — 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_get_init_creds_opt_init" href="krb5_get_init_creds_opt_init.html" /> <link rel="prev" title="krb5_get_in_tkt_with_skey" href="krb5_get_in_tkt_with_skey.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,18 +52,16 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-in-tkt-with-keytab"> + <section id="krb5-get-in-tkt-with-keytab"> <h1>krb5_get_in_tkt_with_keytab<a class="headerlink" href="#krb5-get-in-tkt-with-keytab" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_in_tkt_with_keytab"> -<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_get_in_tkt_with_keytab</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *const *<em> addrs</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> ktypes</em>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype">krb5_preauthtype</a> *<em> pre_auth_types</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> arg_keytab</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep">krb5_kdc_rep</a> **<em> ret_as_reply</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_keytab" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_in_tkt_with_keytab"> +<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_get_in_tkt_with_keytab</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addrs</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ktypes</span></span>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype"><span class="n"><span class="pre">krb5_preauthtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pre_auth_types</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">arg_keytab</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep"><span class="n"><span class="pre">krb5_kdc_rep</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_as_reply</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_keytab" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>options</strong></p> <p><strong>addrs</strong></p> <p><strong>ktypes</strong></p> @@ -80,20 +69,20 @@ <p><strong>arg_keytab</strong></p> <p><strong>ccache</strong></p> <p><strong>creds</strong></p> -<p class="last"><strong>ret_as_reply</strong></p> -</td> -</tr> -</tbody> -</table> -<p>DEPRECATED Replaced by krb5_get_init_creds_keytab() .</p> -</div> +<p><strong>ret_as_reply</strong></p> +</dd> +</dl> +<p>DEPRECATED Replaced by krb5_get_init_creds_keytab().</p> +</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_get_in_tkt_with_keytab</a></li> @@ -137,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -144,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_password.html b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_password.html index c06d9ba1c979..d303e0b9179e 100644 --- a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_password.html +++ b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_password.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_get_in_tkt_with_password — 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_get_in_tkt_with_skey" href="krb5_get_in_tkt_with_skey.html" /> <link rel="prev" title="krb5_get_credentials_validate" href="krb5_get_credentials_validate.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,18 +52,16 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-in-tkt-with-password"> + <section id="krb5-get-in-tkt-with-password"> <h1>krb5_get_in_tkt_with_password<a class="headerlink" href="#krb5-get-in-tkt-with-password" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_in_tkt_with_password"> -<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_get_in_tkt_with_password</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *const *<em> addrs</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> ktypes</em>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype">krb5_preauthtype</a> *<em> pre_auth_types</em>, const char *<em> password</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep">krb5_kdc_rep</a> **<em> ret_as_reply</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_in_tkt_with_password"> +<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_get_in_tkt_with_password</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addrs</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ktypes</span></span>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype"><span class="n"><span class="pre">krb5_preauthtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pre_auth_types</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">password</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep"><span class="n"><span class="pre">krb5_kdc_rep</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_as_reply</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>options</strong></p> <p><strong>addrs</strong></p> <p><strong>ktypes</strong></p> @@ -80,20 +69,20 @@ <p><strong>password</strong></p> <p><strong>ccache</strong></p> <p><strong>creds</strong></p> -<p class="last"><strong>ret_as_reply</strong></p> -</td> -</tr> -</tbody> -</table> -<p>DEPRECATED Replaced by krb5_get_init_creds_password() .</p> -</div> +<p><strong>ret_as_reply</strong></p> +</dd> +</dl> +<p>DEPRECATED Replaced by krb5_get_init_creds_password().</p> +</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_get_in_tkt_with_password</a></li> @@ -137,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -144,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_skey.html b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_skey.html index 3c7385b1bb79..11a5661ed445 100644 --- a/doc/html/appdev/refs/api/krb5_get_in_tkt_with_skey.html +++ b/doc/html/appdev/refs/api/krb5_get_in_tkt_with_skey.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_get_in_tkt_with_skey — 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_get_in_tkt_with_keytab" href="krb5_get_in_tkt_with_keytab.html" /> <link rel="prev" title="krb5_get_in_tkt_with_password" href="krb5_get_in_tkt_with_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,18 +52,16 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-in-tkt-with-skey"> + <section id="krb5-get-in-tkt-with-skey"> <h1>krb5_get_in_tkt_with_skey<a class="headerlink" href="#krb5-get-in-tkt-with-skey" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_in_tkt_with_skey"> -<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_get_in_tkt_with_skey</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> *const *<em> addrs</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> ktypes</em>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype">krb5_preauthtype</a> *<em> pre_auth_types</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_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep">krb5_kdc_rep</a> **<em> ret_as_reply</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_skey" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_in_tkt_with_skey"> +<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_get_in_tkt_with_skey</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>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addrs</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ktypes</span></span>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype"><span class="n"><span class="pre">krb5_preauthtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pre_auth_types</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_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_kdc_rep.html#c.krb5_kdc_rep" title="krb5_kdc_rep"><span class="n"><span class="pre">krb5_kdc_rep</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_as_reply</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_in_tkt_with_skey" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>options</strong></p> <p><strong>addrs</strong></p> <p><strong>ktypes</strong></p> @@ -80,20 +69,20 @@ <p><strong>key</strong></p> <p><strong>ccache</strong></p> <p><strong>creds</strong></p> -<p class="last"><strong>ret_as_reply</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>ret_as_reply</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_get_init_creds().</p> -</div> +</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_get_in_tkt_with_skey</a></li> @@ -137,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -144,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_keytab.html b/doc/html/appdev/refs/api/krb5_get_init_creds_keytab.html index 96134b299542..760fc2839d0f 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_keytab.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_keytab.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_get_init_creds_keytab - Get initial credentials using a key table. — 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_get_init_creds_opt_alloc - Allocate a new initial credential options structure." href="krb5_get_init_creds_opt_alloc.html" /> <link rel="prev" title="krb5_get_fallback_host_realm" href="krb5_get_fallback_host_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-keytab-get-initial-credentials-using-a-key-table"> + <section id="krb5-get-init-creds-keytab-get-initial-credentials-using-a-key-table"> <h1>krb5_get_init_creds_keytab - Get initial credentials using a key table.<a class="headerlink" href="#krb5-get-init-creds-keytab-get-initial-credentials-using-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_keytab"> -<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_get_init_creds_keytab</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> arg_keytab</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> start_time</em>, const char *<em> in_tkt_service</em>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> k5_gic_options</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_keytab" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_keytab"> +<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_get_init_creds_keytab</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">arg_keytab</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">start_time</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_tkt_service</span></span>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">k5_gic_options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_keytab" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>creds</strong> - New credentials</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal</p> <p><strong>[in]</strong> <strong>arg_keytab</strong> - Key table handle</p> <p><strong>[in]</strong> <strong>start_time</strong> - Time when ticket becomes valid (0 for now)</p> <p><strong>[in]</strong> <strong>in_tkt_service</strong> - Service name of initial credentials (or NULL)</p> -<p class="last"><strong>[in]</strong> <strong>k5_gic_options</strong> - Initial credential options</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>k5_gic_options</strong> - Initial credential options</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function requests KDC for an initial credentials for <em>client</em> using a client key stored in <em>arg_keytab</em> . If <em>in_tkt_service</em> is specified, it is parsed as a principal name (with the realm ignored) and used as the service principal for the request; otherwise the ticket-granting service is used.</p> -</div> +</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_get_init_creds_keytab - Get initial credentials using a key table.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_alloc.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_alloc.html index 12b8d64af807..584d8035ac8f 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_alloc.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_alloc.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_get_init_creds_opt_alloc - Allocate a new initial credential options structure. — 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_get_init_creds_opt_free - Free initial credential options." href="krb5_get_init_creds_opt_free.html" /> <link rel="prev" title="krb5_get_init_creds_keytab - Get initial credentials using a key table." href="krb5_get_init_creds_keytab.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-alloc-allocate-a-new-initial-credential-options-structure"> + <section id="krb5-get-init-creds-opt-alloc-allocate-a-new-initial-credential-options-structure"> <h1>krb5_get_init_creds_opt_alloc - Allocate a new initial credential options structure.<a class="headerlink" href="#krb5-get-init-creds-opt-alloc-allocate-a-new-initial-credential-options-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_alloc"> -<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_get_init_creds_opt_alloc</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> **<em> opt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_alloc" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_alloc"> +<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_get_init_creds_opt_alloc</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_alloc" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>opt</strong> - New options structure</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; Kerberos errors otherwise.</li> +<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>[out]</strong> <strong>opt</strong> - New options structure</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; Kerberos errors otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function is the preferred way to create an options structure for getting initial credentials, and is required to make use of certain options. Use <a class="reference internal" href="krb5_get_init_creds_opt_free.html#c.krb5_get_init_creds_opt_free" title="krb5_get_init_creds_opt_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_free()</span></code></a> to free <em>opt</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function is the preferred way to create an options structure for getting initial credentials, and is required to make use of certain options. Use krb5_get_init_creds_opt_free() to free <em>opt</em> when it is no longer needed.</p> +</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_get_init_creds_opt_alloc - Allocate a new initial credential options structure.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_free.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_free.html index ff8c7ad43e22..622b94a16725 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_free.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_free.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_get_init_creds_opt_free - Free initial credential options. — 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_get_init_creds_opt_get_fast_flags - Retrieve FAST flags from initial credential options." href="krb5_get_init_creds_opt_get_fast_flags.html" /> <link rel="prev" title="krb5_get_init_creds_opt_alloc - Allocate a new initial credential options structure." href="krb5_get_init_creds_opt_alloc.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-free-free-initial-credential-options"> + <section id="krb5-get-init-creds-opt-free-free-initial-credential-options"> <h1>krb5_get_init_creds_opt_free - Free initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-free-free-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_free"> -void <code class="descname">krb5_get_init_creds_opt_free</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_free</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>opt</strong> - Options structure to free</p> -</td> -</tr> -</tbody> -</table> +<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>opt</strong> - Options structure to free</p> +</dd> +</dl> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_get_init_creds_opt_alloc.html#c.krb5_get_init_creds_opt_alloc" title="krb5_get_init_creds_opt_alloc"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_alloc()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_get_init_creds_opt_alloc()</p> </div> +</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_get_init_creds_opt_free - Free initial credential options.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_get_init_creds_opt_free</code><span class="sig- <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ void <code class="descname">krb5_get_init_creds_opt_free</code><span class="sig- <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_get_fast_flags.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_get_fast_flags.html index d59aaf98f68a..9f189db8e7dc 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_get_fast_flags.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_get_fast_flags.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_get_init_creds_opt_get_fast_flags - Retrieve FAST flags from initial credential options. — 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_get_init_creds_opt_set_address_list - Set address restrictions in initial credential options." href="krb5_get_init_creds_opt_set_address_list.html" /> <link rel="prev" title="krb5_get_init_creds_opt_free - Free initial credential options." href="krb5_get_init_creds_opt_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-get-fast-flags-retrieve-fast-flags-from-initial-credential-options"> + <section id="krb5-get-init-creds-opt-get-fast-flags-retrieve-fast-flags-from-initial-credential-options"> <h1>krb5_get_init_creds_opt_get_fast_flags - Retrieve FAST flags from initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-get-fast-flags-retrieve-fast-flags-from-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_get_fast_flags"> -<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_get_init_creds_opt_get_fast_flags</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a> *<em> out_flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_get_fast_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_get_fast_flags"> +<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_get_init_creds_opt_get_fast_flags</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_get_fast_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[out]</strong> <strong>out_flags</strong> - FAST flags</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; Kerberos errors otherwise.</li> +<p><strong>[out]</strong> <strong>out_flags</strong> - FAST flags</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; Kerberos errors otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_get_init_creds_opt_get_fast_flags - Retrieve FAST flags from initial credential options.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_init.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_init.html index d4a1f7bfb4d6..6bbaa0a06536 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_init.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_init.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_get_init_creds_opt_init — 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_init_random_key" href="krb5_init_random_key.html" /> <link rel="prev" title="krb5_get_in_tkt_with_keytab" href="krb5_get_in_tkt_with_keytab.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,30 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-init"> + <section id="krb5-get-init-creds-opt-init"> <h1>krb5_get_init_creds_opt_init<a class="headerlink" href="#krb5-get-init-creds-opt-init" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_init"> -void <code class="descname">krb5_get_init_creds_opt_init</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_init"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_init</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>opt</strong></td> -</tr> -</tbody> -</table> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>opt</strong></p> +</dd> +</dl> <p>DEPRECATED Use krb5_get_init_creds_opt_alloc() instead.</p> -</div> +</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_get_init_creds_opt_init</a></li> @@ -128,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_init</code><span class="sig- <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -135,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_init</code><span class="sig- <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_address_list.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_address_list.html index 65ffd32b9aa9..a4a03bebc097 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_address_list.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_address_list.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_get_init_creds_opt_set_address_list - Set address restrictions in initial credential options. — 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_get_init_creds_opt_set_anonymous - Set or unset the anonymous flag in initial credential options." href="krb5_get_init_creds_opt_set_anonymous.html" /> <link rel="prev" title="krb5_get_init_creds_opt_get_fast_flags - Retrieve FAST flags from initial credential options." href="krb5_get_init_creds_opt_get_fast_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-address-list-set-address-restrictions-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-address-list-set-address-restrictions-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_address_list - Set address restrictions in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-address-list-set-address-restrictions-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_address_list"> -void <code class="descname">krb5_get_init_creds_opt_set_address_list</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> **<em> addresses</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_address_list" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_address_list"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_address_list</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addresses</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_address_list" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>addresses</strong> - Null-terminated array of addresses</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>addresses</strong> - Null-terminated array of addresses</p> +</dd> +</dl> +</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_get_init_creds_opt_set_address_list - Set address restrictions in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_address_list</code><span <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_address_list</code><span <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_anonymous.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_anonymous.html index ced5b99a53d4..104511d15853 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_anonymous.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_anonymous.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_get_init_creds_opt_set_anonymous - Set or unset the anonymous flag in initial credential options. — 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_get_init_creds_opt_set_canonicalize - Set or unset the canonicalize flag in initial credential options." href="krb5_get_init_creds_opt_set_canonicalize.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_address_list - Set address restrictions in initial credential options." href="krb5_get_init_creds_opt_set_address_list.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-anonymous-set-or-unset-the-anonymous-flag-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-anonymous-set-or-unset-the-anonymous-flag-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_anonymous - Set or unset the anonymous flag in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-anonymous-set-or-unset-the-anonymous-flag-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_anonymous"> -void <code class="descname">krb5_get_init_creds_opt_set_anonymous</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, int<em> anonymous</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_anonymous" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_anonymous"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_anonymous</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">anonymous</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_anonymous" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>anonymous</strong> - Whether to make an anonymous request</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>anonymous</strong> - Whether to make an anonymous request</p> +</dd> +</dl> <p>This function may be used to request anonymous credentials from the KDC by setting <em>anonymous</em> to non-zero. Note that anonymous credentials are only a request; clients must verify that credentials are anonymous if that is a requirement.</p> -</div> +</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_get_init_creds_opt_set_anonymous - Set or unset the anonymous flag in initial credential options.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_anonymous</code><span cl <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_anonymous</code><span cl <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_canonicalize.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_canonicalize.html index 33935b708e18..c424621ad6aa 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_canonicalize.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_canonicalize.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_get_init_creds_opt_set_canonicalize - Set or unset the canonicalize flag in initial credential options. — 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_get_init_creds_opt_set_change_password_prompt - Set or unset change-password-prompt flag in initial credential options." href="krb5_get_init_creds_opt_set_change_password_prompt.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_anonymous - Set or unset the anonymous flag in initial credential options." href="krb5_get_init_creds_opt_set_anonymous.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-canonicalize-set-or-unset-the-canonicalize-flag-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-canonicalize-set-or-unset-the-canonicalize-flag-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_canonicalize - Set or unset the canonicalize flag in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-canonicalize-set-or-unset-the-canonicalize-flag-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_canonicalize"> -void <code class="descname">krb5_get_init_creds_opt_set_canonicalize</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, int<em> canonicalize</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_canonicalize" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_canonicalize"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_canonicalize</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">canonicalize</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_canonicalize" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>canonicalize</strong> - Whether to canonicalize client principal</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>canonicalize</strong> - Whether to canonicalize client principal</p> +</dd> +</dl> +</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_get_init_creds_opt_set_canonicalize - Set or unset the canonicalize flag in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_canonicalize</code><span <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_canonicalize</code><span <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_change_password_prompt.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_change_password_prompt.html index 70fcadbae1a0..97f4aaac72ac 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_change_password_prompt.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_change_password_prompt.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_get_init_creds_opt_set_change_password_prompt - Set or unset change-password-prompt flag in initial credential options. — 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_get_init_creds_opt_set_etype_list - Set allowable encryption types in initial credential options." href="krb5_get_init_creds_opt_set_etype_list.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_canonicalize - Set or unset the canonicalize flag in initial credential options." href="krb5_get_init_creds_opt_set_canonicalize.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-change-password-prompt-set-or-unset-change-password-prompt-flag-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-change-password-prompt-set-or-unset-change-password-prompt-flag-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_change_password_prompt - Set or unset change-password-prompt flag in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-change-password-prompt-set-or-unset-change-password-prompt-flag-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_change_password_prompt"> -void <code class="descname">krb5_get_init_creds_opt_set_change_password_prompt</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, int<em> prompt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_change_password_prompt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_change_password_prompt"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_change_password_prompt</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">prompt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_change_password_prompt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>prompt</strong> - Whether to prompt to change password</p> -</td> -</tr> -</tbody> -</table> -<p>This flag is on by default. It controls whether <a class="reference internal" href="krb5_get_init_creds_password.html#c.krb5_get_init_creds_password" title="krb5_get_init_creds_password"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_password()</span></code></a> will react to an expired-password error by prompting for a new password and attempting to change the old one.</p> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>prompt</strong> - Whether to prompt to change password</p> +</dd> +</dl> +<p>This flag is on by default. It controls whether krb5_get_init_creds_password() will react to an expired-password error by prompting for a new password and attempting to change the old one.</p> +</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_get_init_creds_opt_set_change_password_prompt - Set or unset change-password-prompt flag in initial credential options.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_change_password_prompt</ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_change_password_prompt</ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_etype_list.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_etype_list.html index ed08891235fc..f8480408e9a3 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_etype_list.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_etype_list.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_get_init_creds_opt_set_etype_list - Set allowable encryption types in initial credential options. — 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_get_init_creds_opt_set_expire_callback - Set an expiration callback in initial credential options." href="krb5_get_init_creds_opt_set_expire_callback.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_change_password_prompt - Set or unset change-password-prompt flag in initial credential options." href="krb5_get_init_creds_opt_set_change_password_prompt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-etype-list-set-allowable-encryption-types-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-etype-list-set-allowable-encryption-types-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_etype_list - Set allowable encryption types in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-etype-list-set-allowable-encryption-types-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_etype_list"> -void <code class="descname">krb5_get_init_creds_opt_set_etype_list</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> etype_list</em>, int<em> etype_list_length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_etype_list" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_etype_list"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_etype_list</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">etype_list</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">etype_list_length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_etype_list" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> <p><strong>[in]</strong> <strong>etype_list</strong> - Array of encryption types</p> -<p class="last"><strong>[in]</strong> <strong>etype_list_length</strong> - Length of <em>etype_list</em></p> -</td> -</tr> -</tbody> -</table> -</div> +<p><strong>[in]</strong> <strong>etype_list_length</strong> - Length of <em>etype_list</em></p> +</dd> +</dl> +</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_get_init_creds_opt_set_etype_list - Set allowable encryption types in initial credential options.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_etype_list</code><span c <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_etype_list</code><span c <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_expire_callback.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_expire_callback.html index debc270de251..3d00dbfa6ad9 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_expire_callback.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_expire_callback.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_get_init_creds_opt_set_expire_callback - Set an expiration callback in initial credential options. — 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_get_init_creds_opt_set_fast_ccache - Set FAST armor cache in initial credential options." href="krb5_get_init_creds_opt_set_fast_ccache.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_etype_list - Set allowable encryption types in initial credential options." href="krb5_get_init_creds_opt_set_etype_list.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-expire-callback-set-an-expiration-callback-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-expire-callback-set-an-expiration-callback-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_expire_callback - Set an expiration callback in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-expire-callback-set-an-expiration-callback-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_expire_callback"> -<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_get_init_creds_opt_set_expire_callback</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_expire_callback_func.html#c.krb5_expire_callback_func" title="krb5_expire_callback_func">krb5_expire_callback_func</a><em> cb</em>, void *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_expire_callback" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_expire_callback"> +<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_get_init_creds_opt_set_expire_callback</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_expire_callback_func.html#c.krb5_expire_callback_func" title="krb5_expire_callback_func"><span class="n"><span class="pre">krb5_expire_callback_func</span></span></a><span class="w"> </span><span class="n"><span class="pre">cb</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_expire_callback" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> <p><strong>[in]</strong> <strong>cb</strong> - Callback function</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Callback argument</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>data</strong> - Callback argument</p> +</dd> +</dl> <p>Set a callback to receive password and account expiration times.</p> <blockquote> -<div><em>cb</em> will be invoked if and only if credentials are successfully acquired. The callback will receive the <em>context</em> from the calling function and the <em>data</em> argument supplied with this API. The remaining arguments should be interpreted as follows:</div></blockquote> +<div><p><em>cb</em> will be invoked if and only if credentials are successfully acquired. The callback will receive the <em>context</em> from the calling function and the <em>data</em> argument supplied with this API. The remaining arguments should be interpreted as follows:</p> +</div></blockquote> <p>If <em>is_last_req</em> is true, then the KDC reply contained last-req entries which unambiguously indicated the password expiration, account expiration, or both. (If either value was not present, the corresponding argument will be 0.) Furthermore, a non-zero <em>password_expiration</em> should be taken as a suggestion from the KDC that a warning be displayed.</p> <p>If <em>is_last_req</em> is false, then <em>account_expiration</em> will be 0 and <em>password_expiration</em> will contain the expiration time of either the password or account, or 0 if no expiration time was indicated in the KDC reply. The callback should independently decide whether to display a password expiration warning.</p> <p>Note that <em>cb</em> may be invoked even if credentials are being acquired for the kadmin/changepw service in order to change the password. It is the caller’s responsibility to avoid displaying a password expiry warning in this case.</p> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">Setting an expire callback with this API will cause <a class="reference internal" href="krb5_get_init_creds_password.html#c.krb5_get_init_creds_password" title="krb5_get_init_creds_password"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_password()</span></code></a> not to send password expiry warnings to the prompter, as it ordinarily may.</p> +<p class="admonition-title">Warning</p> +<p>Setting an expire callback with this API will cause krb5_get_init_creds_password() not to send password expiry warnings to the prompter, as it ordinarily may.</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_get_init_creds_opt_set_expire_callback - Set an expiration callback in initial credential options.</a></li> @@ -145,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache.html index 06106d75557f..70be56334cef 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache.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_get_init_creds_opt_set_fast_ccache - Set FAST armor cache in initial credential options. — 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_get_init_creds_opt_set_fast_ccache_name - Set location of FAST armor ccache in initial credential options." href="krb5_get_init_creds_opt_set_fast_ccache_name.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_expire_callback - Set an expiration callback in initial credential options." href="krb5_get_init_creds_opt_set_expire_callback.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-fast-ccache-set-fast-armor-cache-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-fast-ccache-set-fast-armor-cache-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_fast_ccache - Set FAST armor cache in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-fast-ccache-set-fast-armor-cache-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_fast_ccache"> -<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_get_init_creds_opt_set_fast_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_ccache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_fast_ccache"> +<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_get_init_creds_opt_set_fast_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_ccache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> -</td> -</tr> -</tbody> -</table> -<p>This function is similar to <a class="reference internal" href="krb5_get_init_creds_opt_set_fast_ccache_name.html#c.krb5_get_init_creds_opt_set_fast_ccache_name" title="krb5_get_init_creds_opt_set_fast_ccache_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_fast_ccache_name()</span></code></a> , but uses a credential cache handle instead of a name.</p> +<p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> +</dd> +</dl> +<p>This function is similar to krb5_get_init_creds_opt_set_fast_ccache_name(), but uses a credential cache handle instead of a name.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_get_init_creds_opt_set_fast_ccache - Set FAST armor cache in initial credential options.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache_name.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache_name.html index 5f56f4f61717..adb5003607b5 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache_name.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_ccache_name.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_get_init_creds_opt_set_fast_ccache_name - Set location of FAST armor ccache in initial credential options. — 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_get_init_creds_opt_set_fast_flags - Set FAST flags in initial credential options." href="krb5_get_init_creds_opt_set_fast_flags.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_fast_ccache - Set FAST armor cache in initial credential options." href="krb5_get_init_creds_opt_set_fast_ccache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-fast-ccache-name-set-location-of-fast-armor-ccache-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-fast-ccache-name-set-location-of-fast-armor-ccache-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_fast_ccache_name - Set location of FAST armor ccache in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-fast-ccache-name-set-location-of-fast-armor-ccache-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_fast_ccache_name"> -<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_get_init_creds_opt_set_fast_ccache_name</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, const char *<em> fast_ccache_name</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_ccache_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_fast_ccache_name"> +<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_get_init_creds_opt_set_fast_ccache_name</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fast_ccache_name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_ccache_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[in]</strong> <strong>fast_ccache_name</strong> - Credential cache name</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>fast_ccache_name</strong> - Credential cache name</p> +</dd> +</dl> <p>Sets the location of a credential cache containing an armor ticket to protect an initial credential exchange using the FAST protocol extension.</p> -<p>In version 1.7, setting an armor ccache requires that FAST be used for the exchange. In version 1.8 or later, setting the armor ccache causes FAST to be used if the KDC supports it; <a class="reference internal" href="krb5_get_init_creds_opt_set_fast_flags.html#c.krb5_get_init_creds_opt_set_fast_flags" title="krb5_get_init_creds_opt_set_fast_flags"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_fast_flags()</span></code></a> must be used to require that FAST be used.</p> -</div> +<p>In version 1.7, setting an armor ccache requires that FAST be used for the exchange. In version 1.8 or later, setting the armor ccache causes FAST to be used if the KDC supports it; krb5_get_init_creds_opt_set_fast_flags() must be used to require that FAST be used.</p> +</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_get_init_creds_opt_set_fast_ccache_name - Set location of FAST armor ccache in initial credential options.</a></li> @@ -132,6 +121,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_flags.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_flags.html index 870df0e76f52..6c0111960e0c 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_flags.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_fast_flags.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_get_init_creds_opt_set_fast_flags - Set FAST flags in initial credential options. — 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_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options." href="krb5_get_init_creds_opt_set_forwardable.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_fast_ccache_name - Set location of FAST armor ccache in initial credential options." href="krb5_get_init_creds_opt_set_fast_ccache_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-fast-flags-set-fast-flags-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-fast-flags-set-fast-flags-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_fast_flags - Set FAST flags in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-fast-flags-set-fast-flags-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_fast_flags"> -<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_get_init_creds_opt_set_fast_flags</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_fast_flags"> +<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_get_init_creds_opt_set_fast_flags</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_fast_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[in]</strong> <strong>flags</strong> - FAST flags</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; Kerberos errors otherwise.</li> +<p><strong>[in]</strong> <strong>flags</strong> - FAST flags</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; Kerberos errors otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>The following flag values are valid:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_FAST_REQUIRED.html#KRB5_FAST_REQUIRED" title="KRB5_FAST_REQUIRED"><code class="xref py py-data docutils literal"><span class="pre">KRB5_FAST_REQUIRED</span></code></a> - Require FAST to be used</li> +<li><p>#KRB5_FAST_REQUIRED - Require FAST to be used</p></li> </ul> </div></blockquote> -</div> +</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_get_init_creds_opt_set_fast_flags - Set FAST flags in initial credential options.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_forwardable.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_forwardable.html index ed2e53e5667c..793b939d6870 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_forwardable.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_forwardable.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_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options. — 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_get_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options." href="krb5_get_init_creds_opt_set_in_ccache.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_fast_flags - Set FAST flags in initial credential options." href="krb5_get_init_creds_opt_set_fast_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-forwardable-set-or-unset-the-forwardable-flag-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-forwardable-set-or-unset-the-forwardable-flag-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-forwardable-set-or-unset-the-forwardable-flag-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_forwardable"> -void <code class="descname">krb5_get_init_creds_opt_set_forwardable</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, int<em> forwardable</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_forwardable" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_forwardable"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_forwardable</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">forwardable</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_forwardable" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>forwardable</strong> - Whether credentials should be forwardable</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>forwardable</strong> - Whether credentials should be forwardable</p> +</dd> +</dl> +</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_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_forwardable</code><span <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_forwardable</code><span <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_in_ccache.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_in_ccache.html index b198850a25fe..165986dff27c 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_in_ccache.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_in_ccache.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_get_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options. — 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_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options." href="krb5_get_init_creds_opt_set_out_ccache.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_forwardable - Set or unset the forwardable flag in initial credential options." href="krb5_get_init_creds_opt_set_forwardable.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-in-ccache-set-an-input-credential-cache-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-in-ccache-set-an-input-credential-cache-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-in-ccache-set-an-input-credential-cache-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_in_ccache"> -<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_get_init_creds_opt_set_in_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_in_ccache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_in_ccache"> +<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_get_init_creds_opt_set_in_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_in_ccache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> +</dd> +</dl> <p>If an input credential cache is set, then the krb5_get_init_creds family of APIs will read settings from it. Setting an input ccache is desirable when the application wishes to perform authentication in the same way (using the same preauthentication mechanisms, and making the same non-security- sensitive choices) as the previous authentication attempt, which stored information in the passed-in ccache.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_get_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_out_ccache.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_out_ccache.html index 67977023fe4f..a57acf2d5231 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_out_ccache.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_out_ccache.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_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options. — 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_get_init_creds_opt_set_pa - Supply options for preauthentication in initial credential options." href="krb5_get_init_creds_opt_set_pa.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_in_ccache - Set an input credential cache in initial credential options." href="krb5_get_init_creds_opt_set_in_ccache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-out-ccache-set-an-output-credential-cache-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-out-ccache-set-an-output-credential-cache-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-out-ccache-set-an-output-credential-cache-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_out_ccache"> -<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_get_init_creds_opt_set_out_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_out_ccache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_out_ccache"> +<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_get_init_creds_opt_set_out_ccache</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_out_ccache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options</p> -<p class="last"><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>ccache</strong> - Credential cache handle</p> +</dd> +</dl> <p>If an output credential cache is set, then the krb5_get_init_creds family of APIs will write credentials to it. Setting an output ccache is desirable both because it simplifies calling code and because it permits the krb5_get_init_creds APIs to write out configuration information about the realm to the ccache.</p> -</div> +</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_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options.</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pa.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pa.html index fa9822d46010..131a76d02eb0 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pa.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pa.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_get_init_creds_opt_set_pa - Supply options for preauthentication in initial credential options. — 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_get_init_creds_opt_set_pac_request - Ask the KDC to include or not include a PAC in the ticket." href="krb5_get_init_creds_opt_set_pac_request.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_out_ccache - Set an output credential cache in initial credential options." href="krb5_get_init_creds_opt_set_out_ccache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-pa-supply-options-for-preauthentication-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-pa-supply-options-for-preauthentication-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_pa - Supply options for preauthentication in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-pa-supply-options-for-preauthentication-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_pa"> -<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_get_init_creds_opt_set_pa</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, const char *<em> attr</em>, const char *<em> value</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_pa" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_pa"> +<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_get_init_creds_opt_set_pa</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">attr</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_pa" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> <p><strong>[in]</strong> <strong>attr</strong> - Preauthentication option name</p> -<p class="last"><strong>[in]</strong> <strong>value</strong> - Preauthentication option value</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>value</strong> - Preauthentication option value</p> +</dd> +</dl> <p>This function allows the caller to supply options for preauthentication. The values of <em>attr</em> and <em>value</em> are supplied to each preauthentication module available within <em>context</em> .</p> -</div> +</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_get_init_creds_opt_set_pa - Supply options for preauthentication in initial credential options.</a></li> @@ -132,6 +121,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pac_request.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pac_request.html index e836ccda3a3e..58a337d9d366 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pac_request.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_pac_request.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_get_init_creds_opt_set_pac_request - Ask the KDC to include or not include a PAC in the ticket. — 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_get_init_creds_opt_set_preauth_list - Set preauthentication types in initial credential options." href="krb5_get_init_creds_opt_set_preauth_list.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_pa - Supply options for preauthentication in initial credential options." href="krb5_get_init_creds_opt_set_pa.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-pac-request-ask-the-kdc-to-include-or-not-include-a-pac-in-the-ticket"> + <section id="krb5-get-init-creds-opt-set-pac-request-ask-the-kdc-to-include-or-not-include-a-pac-in-the-ticket"> <h1>krb5_get_init_creds_opt_set_pac_request - Ask the KDC to include or not include a PAC in the ticket.<a class="headerlink" href="#krb5-get-init-creds-opt-set-pac-request-ask-the-kdc-to-include-or-not-include-a-pac-in-the-ticket" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_pac_request"> -<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_get_init_creds_opt_set_pac_request</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> req_pac</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_pac_request" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_pac_request"> +<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_get_init_creds_opt_set_pac_request</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">req_pac</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_pac_request" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>req_pac</strong> - Whether to request a PAC or not</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>req_pac</strong> - Whether to request a PAC or not</p> +</dd> +</dl> <p>If this option is set, the AS request will include a PAC-REQUEST pa-data item explicitly asking the KDC to either include or not include a privilege attribute certificate in the ticket authorization data. By default, no request is made; typically the KDC will default to including a PAC if it supports them.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.15</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.15</p> </div> +</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_get_init_creds_opt_set_pac_request - Ask the KDC to include or not include a PAC in the ticket.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_preauth_list.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_preauth_list.html index df6654bddfdc..94f4b41c9dea 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_preauth_list.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_preauth_list.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_get_init_creds_opt_set_preauth_list - Set preauthentication types in initial credential options. — 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_get_init_creds_opt_set_proxiable - Set or unset the proxiable flag in initial credential options." href="krb5_get_init_creds_opt_set_proxiable.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_pac_request - Ask the KDC to include or not include a PAC in the ticket." href="krb5_get_init_creds_opt_set_pac_request.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-preauth-list-set-preauthentication-types-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-preauth-list-set-preauthentication-types-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_preauth_list - Set preauthentication types in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-preauth-list-set-preauthentication-types-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_preauth_list"> -void <code class="descname">krb5_get_init_creds_opt_set_preauth_list</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype">krb5_preauthtype</a> *<em> preauth_list</em>, int<em> preauth_list_length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_preauth_list" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_preauth_list"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_preauth_list</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_preauthtype.html#c.krb5_preauthtype" title="krb5_preauthtype"><span class="n"><span class="pre">krb5_preauthtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">preauth_list</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">preauth_list_length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_preauth_list" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> <p><strong>[in]</strong> <strong>preauth_list</strong> - Array of preauthentication types</p> -<p class="last"><strong>[in]</strong> <strong>preauth_list_length</strong> - Length of <em>preauth_list</em></p> -</td> -</tr> -</tbody> -</table> -<p>This function can be used to perform optimistic preauthentication when getting initial credentials, in combination with <a class="reference internal" href="krb5_get_init_creds_opt_set_salt.html#c.krb5_get_init_creds_opt_set_salt" title="krb5_get_init_creds_opt_set_salt"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_salt()</span></code></a> and <a class="reference internal" href="krb5_get_init_creds_opt_set_pa.html#c.krb5_get_init_creds_opt_set_pa" title="krb5_get_init_creds_opt_set_pa"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_opt_set_pa()</span></code></a> .</p> -</div> +<p><strong>[in]</strong> <strong>preauth_list_length</strong> - Length of <em>preauth_list</em></p> +</dd> +</dl> +<p>This function can be used to perform optimistic preauthentication when getting initial credentials, in combination with krb5_get_init_creds_opt_set_salt() and krb5_get_init_creds_opt_set_pa().</p> +</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_get_init_creds_opt_set_preauth_list - Set preauthentication types in initial credential options.</a></li> @@ -131,6 +120,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_preauth_list</code><span <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_preauth_list</code><span <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_proxiable.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_proxiable.html index 697358bdf599..fb570f3034f3 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_proxiable.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_proxiable.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_get_init_creds_opt_set_proxiable - Set or unset the proxiable flag in initial credential options. — 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_get_init_creds_opt_set_renew_life - Set the ticket renewal lifetime in initial credential options." href="krb5_get_init_creds_opt_set_renew_life.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_preauth_list - Set preauthentication types in initial credential options." href="krb5_get_init_creds_opt_set_preauth_list.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-proxiable-set-or-unset-the-proxiable-flag-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-proxiable-set-or-unset-the-proxiable-flag-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_proxiable - Set or unset the proxiable flag in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-proxiable-set-or-unset-the-proxiable-flag-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_proxiable"> -void <code class="descname">krb5_get_init_creds_opt_set_proxiable</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, int<em> proxiable</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_proxiable" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_proxiable"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_proxiable</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">proxiable</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_proxiable" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>proxiable</strong> - Whether credentials should be proxiable</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>proxiable</strong> - Whether credentials should be proxiable</p> +</dd> +</dl> +</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_get_init_creds_opt_set_proxiable - Set or unset the proxiable flag in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_proxiable</code><span cl <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_proxiable</code><span cl <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_renew_life.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_renew_life.html index 186309479343..b671b95ad2ff 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_renew_life.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_renew_life.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_get_init_creds_opt_set_renew_life - Set the ticket renewal lifetime in initial credential options. — 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_get_init_creds_opt_set_responder - Set the responder function in initial credential options." href="krb5_get_init_creds_opt_set_responder.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_proxiable - Set or unset the proxiable flag in initial credential options." href="krb5_get_init_creds_opt_set_proxiable.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-renew-life-set-the-ticket-renewal-lifetime-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-renew-life-set-the-ticket-renewal-lifetime-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_renew_life - Set the ticket renewal lifetime in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-renew-life-set-the-ticket-renewal-lifetime-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_renew_life"> -void <code class="descname">krb5_get_init_creds_opt_set_renew_life</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> renew_life</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_renew_life" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_renew_life"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_renew_life</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">renew_life</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_renew_life" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Pointer to <em>options</em> field</p> -<p class="last"><strong>[in]</strong> <strong>renew_life</strong> - Ticket renewal lifetime</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Pointer to <em>options</em> field</p> +<p><strong>[in]</strong> <strong>renew_life</strong> - Ticket renewal lifetime</p> +</dd> +</dl> +</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_get_init_creds_opt_set_renew_life - Set the ticket renewal lifetime in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_renew_life</code><span c <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_renew_life</code><span c <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_responder.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_responder.html index 3db8783419f4..1f2ff1158df2 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_responder.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_responder.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_get_init_creds_opt_set_responder - Set the responder function in initial credential options. — 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_get_init_creds_opt_set_salt - Set salt for optimistic preauthentication in initial credential options." href="krb5_get_init_creds_opt_set_salt.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_renew_life - Set the ticket renewal lifetime in initial credential options." href="krb5_get_init_creds_opt_set_renew_life.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-responder-set-the-responder-function-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-responder-set-the-responder-function-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_responder - Set the responder function in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-responder-set-the-responder-function-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_responder"> -<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_get_init_creds_opt_set_responder</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_responder_fn.html#c.krb5_responder_fn" title="krb5_responder_fn">krb5_responder_fn</a><em> responder</em>, void *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_responder" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_responder"> +<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_get_init_creds_opt_set_responder</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>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_responder_fn.html#c.krb5_responder_fn" title="krb5_responder_fn"><span class="n"><span class="pre">krb5_responder_fn</span></span></a><span class="w"> </span><span class="n"><span class="pre">responder</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_responder" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> <p><strong>[in]</strong> <strong>responder</strong> - Responder function</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Responder data argument</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>data</strong> - Responder data argument</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_get_init_creds_opt_set_responder - Set the responder function in initial credential options.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_salt.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_salt.html index 77fefbb6ea57..6609f377ba43 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_salt.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_salt.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_get_init_creds_opt_set_salt - Set salt for optimistic preauthentication in initial credential options. — 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_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options." href="krb5_get_init_creds_opt_set_tkt_life.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_responder - Set the responder function in initial credential options." href="krb5_get_init_creds_opt_set_responder.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-salt-set-salt-for-optimistic-preauthentication-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-salt-set-salt-for-optimistic-preauthentication-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_salt - Set salt for optimistic preauthentication in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-salt-set-salt-for-optimistic-preauthentication-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_salt"> -void <code class="descname">krb5_get_init_creds_opt_set_salt</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> salt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_salt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_salt"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_salt</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</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">salt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_salt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>salt</strong> - Salt data</p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>salt</strong> - Salt data</p> +</dd> +</dl> <p>When getting initial credentials with a password, a salt string it used to convert the password to a key. Normally this salt is obtained from the first KDC reply, but when performing optimistic preauthentication, the client may need to supply the salt string with this function.</p> -</div> +</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_get_init_creds_opt_set_salt - Set salt for optimistic preauthentication in initial credential options.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_salt</code><span class=" <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_salt</code><span class=" <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_tkt_life.html b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_tkt_life.html index 36698da38a22..ef0e23eec730 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_tkt_life.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_opt_set_tkt_life.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_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options. — 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_get_init_creds_password - Get initial credentials using a password." href="krb5_get_init_creds_password.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_salt - Set salt for optimistic preauthentication in initial credential options." href="krb5_get_init_creds_opt_set_salt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-opt-set-tkt-life-set-the-ticket-lifetime-in-initial-credential-options"> + <section id="krb5-get-init-creds-opt-set-tkt-life-set-the-ticket-lifetime-in-initial-credential-options"> <h1>krb5_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options.<a class="headerlink" href="#krb5-get-init-creds-opt-set-tkt-life-set-the-ticket-lifetime-in-initial-credential-options" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_opt_set_tkt_life"> -void <code class="descname">krb5_get_init_creds_opt_set_tkt_life</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> opt</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> tkt_life</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_tkt_life" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_opt_set_tkt_life"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_init_creds_opt_set_tkt_life</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">opt</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">tkt_life</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_opt_set_tkt_life" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>opt</strong> - Options structure</p> -<p class="last"><strong>[in]</strong> <strong>tkt_life</strong> - Ticket lifetime</p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>opt</strong> - Options structure</p> +<p><strong>[in]</strong> <strong>tkt_life</strong> - Ticket lifetime</p> +</dd> +</dl> +</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_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_get_init_creds_opt_set_tkt_life</code><span cla <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_get_init_creds_opt_set_tkt_life</code><span cla <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_init_creds_password.html b/doc/html/appdev/refs/api/krb5_get_init_creds_password.html index b8c0f64eae27..db25a9cb9d2b 100644 --- a/doc/html/appdev/refs/api/krb5_get_init_creds_password.html +++ b/doc/html/appdev/refs/api/krb5_get_init_creds_password.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_get_init_creds_password - Get initial credentials using a password. — 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_get_profile - Retrieve configuration profile from the context." href="krb5_get_profile.html" /> <link rel="prev" title="krb5_get_init_creds_opt_set_tkt_life - Set the ticket lifetime in initial credential options." href="krb5_get_init_creds_opt_set_tkt_life.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,18 +52,16 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-init-creds-password-get-initial-credentials-using-a-password"> + <section id="krb5-get-init-creds-password-get-initial-credentials-using-a-password"> <h1>krb5_get_init_creds_password - Get initial credentials using a password.<a class="headerlink" href="#krb5-get-init-creds-password-get-initial-credentials-using-a-password" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_init_creds_password"> -<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_get_init_creds_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, const char *<em> password</em>, <a class="reference internal" href="../types/krb5_prompter_fct.html#c.krb5_prompter_fct" title="krb5_prompter_fct">krb5_prompter_fct</a><em> prompter</em>, void *<em> data</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> start_time</em>, const char *<em> in_tkt_service</em>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> k5_gic_options</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_init_creds_password"> +<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_get_init_creds_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">password</span></span>, <a class="reference internal" href="../types/krb5_prompter_fct.html#c.krb5_prompter_fct" title="krb5_prompter_fct"><span class="n"><span class="pre">krb5_prompter_fct</span></span></a><span class="w"> </span><span class="n"><span class="pre">prompter</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">start_time</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_tkt_service</span></span>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">k5_gic_options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_init_creds_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>creds</strong> - New credentials</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal</p> <p><strong>[in]</strong> <strong>password</strong> - Password (or NULL)</p> @@ -80,45 +69,41 @@ <p><strong>[in]</strong> <strong>data</strong> - Prompter callback data</p> <p><strong>[in]</strong> <strong>start_time</strong> - Time when ticket becomes valid (0 for now)</p> <p><strong>[in]</strong> <strong>in_tkt_service</strong> - Service name of initial credentials (or NULL)</p> -<p class="last"><strong>[in]</strong> <strong>k5_gic_options</strong> - Initial credential options</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 simple"> -<li>0 Success</li> -<li>EINVAL Invalid argument</li> -<li>KRB5_KDC_UNREACH Cannot contact any KDC for requested realm</li> -<li>KRB5_PREAUTH_FAILED Generic Pre-athentication failure</li> -<li>KRB5_LIBOS_PWDINTR Password read interrupted</li> -<li>KRB5_REALM_CANT_RESOLVE Cannot resolve network address for KDC in requested realm</li> -<li>KRB5KDC_ERR_KEY_EXP Password has expired</li> -<li>KRB5_LIBOS_BADPWDMATCH Password mismatch</li> -<li>KRB5_CHPW_PWDNULL New password cannot be zero length</li> -<li>KRB5_CHPW_FAIL Password change failed</li> +<p><strong>[in]</strong> <strong>k5_gic_options</strong> - Initial credential options</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</p></li> +<li><p>EINVAL Invalid argument</p></li> +<li><p>KRB5_KDC_UNREACH Cannot contact any KDC for requested realm</p></li> +<li><p>KRB5_PREAUTH_FAILED Generic Pre-athentication failure</p></li> +<li><p>KRB5_LIBOS_PWDINTR Password read interrupted</p></li> +<li><p>KRB5_REALM_CANT_RESOLVE Cannot resolve network address for KDC in requested realm</p></li> +<li><p>KRB5KDC_ERR_KEY_EXP Password has expired</p></li> +<li><p>KRB5_LIBOS_BADPWDMATCH Password mismatch</p></li> +<li><p>KRB5_CHPW_PWDNULL New password cannot be zero length</p></li> +<li><p>KRB5_CHPW_FAIL Password change failed</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function requests KDC for an initial credentials for <em>client</em> using <em>password</em> . If <em>password</em> is NULL, a password will be prompted for using <em>prompter</em> if necessary. If <em>in_tkt_service</em> is specified, it is parsed as a principal name (with the realm ignored) and used as the service principal for the request; otherwise the ticket-granting service is used.</p> -</div> +</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_get_init_creds_password - Get initial credentials using a password.</a></li> @@ -162,6 +147,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -169,8 +155,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_permitted_enctypes.html b/doc/html/appdev/refs/api/krb5_get_permitted_enctypes.html index f56072e545da..917e809d6c5e 100644 --- a/doc/html/appdev/refs/api/krb5_get_permitted_enctypes.html +++ b/doc/html/appdev/refs/api/krb5_get_permitted_enctypes.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_get_permitted_enctypes - Return a list of encryption types permitted for session keys. — 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_get_server_rcache - Generate a replay cache object for server use and open it." href="krb5_get_server_rcache.html" /> <link rel="prev" title="krb5_get_etype_info - Retrieve enctype, salt and s2kparams from KDC." href="krb5_get_etype_info.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-permitted-enctypes-return-a-list-of-encryption-types-permitted-for-session-keys"> + <section id="krb5-get-permitted-enctypes-return-a-list-of-encryption-types-permitted-for-session-keys"> <h1>krb5_get_permitted_enctypes - Return a list of encryption types permitted for session keys.<a class="headerlink" href="#krb5-get-permitted-enctypes-return-a-list-of-encryption-types-permitted-for-session-keys" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_permitted_enctypes"> -<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_get_permitted_enctypes</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> **<em> ktypes</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_permitted_enctypes" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_permitted_enctypes"> +<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_get_permitted_enctypes</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ktypes</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_permitted_enctypes" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>ktypes</strong> - Zero-terminated list of encryption types</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> +<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>[out]</strong> <strong>ktypes</strong> - Zero-terminated list of encryption types</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> -<p>This function returns the list of encryption types permitted for session keys within <em>context</em> , as determined by configuration or by a previous call to <a class="reference internal" href="krb5_set_default_tgs_enctypes.html#c.krb5_set_default_tgs_enctypes" title="krb5_set_default_tgs_enctypes"><code class="xref c c-func docutils literal"><span class="pre">krb5_set_default_tgs_enctypes()</span></code></a> .</p> -<p>Use <a class="reference internal" href="krb5_free_enctypes.html#c.krb5_free_enctypes" title="krb5_free_enctypes"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_enctypes()</span></code></a> to free <em>ktypes</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function returns the list of encryption types permitted for session keys within <em>context</em> , as determined by configuration or by a previous call to krb5_set_default_tgs_enctypes().</p> +<p>Use krb5_free_enctypes() to free <em>ktypes</em> when it is no longer needed.</p> +</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_get_permitted_enctypes - Return a list of encryption types permitted for session keys.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_profile.html b/doc/html/appdev/refs/api/krb5_get_profile.html index 383582566559..e8b92e71c5a7 100644 --- a/doc/html/appdev/refs/api/krb5_get_profile.html +++ b/doc/html/appdev/refs/api/krb5_get_profile.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_get_profile - Retrieve configuration profile from the context. — 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_get_prompt_types - Get prompt types array from a context." href="krb5_get_prompt_types.html" /> <link rel="prev" title="krb5_get_init_creds_password - Get initial credentials using a password." href="krb5_get_init_creds_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-profile-retrieve-configuration-profile-from-the-context"> + <section id="krb5-get-profile-retrieve-configuration-profile-from-the-context"> <h1>krb5_get_profile - Retrieve configuration profile from the context.<a class="headerlink" href="#krb5-get-profile-retrieve-configuration-profile-from-the-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_profile"> -<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_get_profile</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>, struct _profile_t **<em> profile</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_profile" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_profile"> +<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_get_profile</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">struct</span></span><span class="w"> </span><span class="n"><span class="pre">_profile_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">profile</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_profile" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>profile</strong> - Pointer to data read from a configuration file</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 simple"> -<li>0 Success</li> +<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>[out]</strong> <strong>profile</strong> - Pointer to data read from a configuration file</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function creates a new <em>profile</em> object that reflects profile in the supplied <em>context</em> .</p> <p>The <em>profile</em> object may be freed with profile_release() function. See profile.h and profile API for more details.</p> -</div> +</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_get_profile - Retrieve configuration profile from the context.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_prompt_types.html b/doc/html/appdev/refs/api/krb5_get_prompt_types.html index 807ae930c2d4..60406fc3e478 100644 --- a/doc/html/appdev/refs/api/krb5_get_prompt_types.html +++ b/doc/html/appdev/refs/api/krb5_get_prompt_types.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_get_prompt_types - Get prompt types array from a context. — 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_get_renewed_creds - Get renewed credential from KDC using an existing credential." href="krb5_get_renewed_creds.html" /> <link rel="prev" title="krb5_get_profile - Retrieve configuration profile from the context." href="krb5_get_profile.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-prompt-types-get-prompt-types-array-from-a-context"> + <section id="krb5-get-prompt-types-get-prompt-types-array-from-a-context"> <h1>krb5_get_prompt_types - Get prompt types array from a context.<a class="headerlink" href="#krb5-get-prompt-types-get-prompt-types-array-from-a-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_prompt_types"> -<a class="reference internal" href="../types/krb5_prompt_type.html#c.krb5_prompt_type" title="krb5_prompt_type">krb5_prompt_type</a> * <code class="descname">krb5_get_prompt_types</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_prompt_types" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_prompt_types"> +<a class="reference internal" href="../types/krb5_prompt_type.html#c.krb5_prompt_type" title="krb5_prompt_type"><span class="n"><span class="pre">krb5_prompt_type</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_get_prompt_types</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="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_prompt_types" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>context</strong> - Library context</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>Pointer to an array of prompt types corresponding to the prompter’s prompts arguments. Each type has one of the following values: KRB5_PROMPT_TYPE_PASSWORD KRB5_PROMPT_TYPE_NEW_PASSWORD KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN KRB5_PROMPT_TYPE_PREAUTH</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - Library context</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>Pointer to an array of prompt types corresponding to the prompter’s prompts arguments. Each type has one of the following values: #KRB5_PROMPT_TYPE_PASSWORD #KRB5_PROMPT_TYPE_NEW_PASSWORD #KRB5_PROMPT_TYPE_NEW_PASSWORD_AGAIN #KRB5_PROMPT_TYPE_PREAUTH</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_get_prompt_types - Get prompt types array from a context.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_renewed_creds.html b/doc/html/appdev/refs/api/krb5_get_renewed_creds.html index fbb014508630..654c48b1a0ed 100644 --- a/doc/html/appdev/refs/api/krb5_get_renewed_creds.html +++ b/doc/html/appdev/refs/api/krb5_get_renewed_creds.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_get_renewed_creds - Get renewed credential from KDC using an existing credential. — 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_get_validated_creds - Get validated credentials from the KDC." href="krb5_get_validated_creds.html" /> <link rel="prev" title="krb5_get_prompt_types - Get prompt types array from a context." href="krb5_get_prompt_types.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-renewed-creds-get-renewed-credential-from-kdc-using-an-existing-credential"> + <section id="krb5-get-renewed-creds-get-renewed-credential-from-kdc-using-an-existing-credential"> <h1>krb5_get_renewed_creds - Get renewed credential from KDC using an existing credential.<a class="headerlink" href="#krb5-get-renewed-creds-get-renewed-credential-from-kdc-using-an-existing-credential" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_renewed_creds"> -<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_get_renewed_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, const char *<em> in_tkt_service</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_renewed_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_renewed_creds"> +<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_get_renewed_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_tkt_service</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_renewed_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>creds</strong> - Renewed credentials</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal name</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache</p> -<p class="last"><strong>[in]</strong> <strong>in_tkt_service</strong> - Server principal string (or NULL)</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>in_tkt_service</strong> - Server principal string (or NULL)</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function gets a renewed credential using an existing one from <em>ccache</em> . If <em>in_tkt_service</em> is specified, it is parsed (with the realm part ignored) and used as the server principal of the credential; otherwise, the ticket-granting service is used.</p> <p>If successful, the renewed credential is placed in <em>creds</em> .</p> -</div> +</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_get_renewed_creds - Get renewed credential from KDC using an existing credential.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_server_rcache.html b/doc/html/appdev/refs/api/krb5_get_server_rcache.html index a7421578af23..e0c037ffed77 100644 --- a/doc/html/appdev/refs/api/krb5_get_server_rcache.html +++ b/doc/html/appdev/refs/api/krb5_get_server_rcache.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_get_server_rcache - Generate a replay cache object for server use and open it. — 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_get_time_offsets - Return the time offsets from the os context." href="krb5_get_time_offsets.html" /> <link rel="prev" title="krb5_get_permitted_enctypes - Return a list of encryption types permitted for session keys." href="krb5_get_permitted_enctypes.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-server-rcache-generate-a-replay-cache-object-for-server-use-and-open-it"> + <section id="krb5-get-server-rcache-generate-a-replay-cache-object-for-server-use-and-open-it"> <h1>krb5_get_server_rcache - Generate a replay cache object for server use and open it.<a class="headerlink" href="#krb5-get-server-rcache-generate-a-replay-cache-object-for-server-use-and-open-it" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_server_rcache"> -<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_get_server_rcache</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> piece</em>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache">krb5_rcache</a> *<em> rcptr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_server_rcache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_server_rcache"> +<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_get_server_rcache</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_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">piece</span></span>, <a class="reference internal" href="../types/krb5_rcache.html#c.krb5_rcache" title="krb5_rcache"><span class="n"><span class="pre">krb5_rcache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rcptr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_server_rcache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>piece</strong> - Unused (replay cache identifier)</p> -<p class="last"><strong>[out]</strong> <strong>rcptr</strong> - Handle to an open rcache</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>rcptr</strong> - Handle to an open rcache</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 creates a handle to the default replay cache. Use krb5_rc_close() to close <em>rcptr</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">Prior to release 1.18, this function creates a handle to a different replay cache for each unique value of <em>piece</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>Prior to release 1.18, this function creates a handle to a different replay cache for each unique value of <em>piece</em> .</p> </div> +</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_get_server_rcache - Generate a replay cache object for server use and open it.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_time_offsets.html b/doc/html/appdev/refs/api/krb5_get_time_offsets.html index c64588d5535d..61f73adf9239 100644 --- a/doc/html/appdev/refs/api/krb5_get_time_offsets.html +++ b/doc/html/appdev/refs/api/krb5_get_time_offsets.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_get_time_offsets - Return the time offsets from the os context. — 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_init_context_profile - Create a krb5 library context using a specified profile." href="krb5_init_context_profile.html" /> <link rel="prev" title="krb5_get_server_rcache - Generate a replay cache object for server use and open it." href="krb5_get_server_rcache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-time-offsets-return-the-time-offsets-from-the-os-context"> + <section id="krb5-get-time-offsets-return-the-time-offsets-from-the-os-context"> <h1>krb5_get_time_offsets - Return the time offsets from the os context.<a class="headerlink" href="#krb5-get-time-offsets-return-the-time-offsets-from-the-os-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_time_offsets"> -<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_get_time_offsets</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a> *<em> seconds</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> microseconds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_time_offsets" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_time_offsets"> +<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_get_time_offsets</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">seconds</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">microseconds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_time_offsets" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>seconds</strong> - Time offset, seconds portion</p> -<p class="last"><strong>[out]</strong> <strong>microseconds</strong> - Time offset, microseconds portion</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>microseconds</strong> - Time offset, microseconds portion</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 returns the time offsets in <em>context</em> .</p> -</div> +</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_get_time_offsets - Return the time offsets from the os context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_get_validated_creds.html b/doc/html/appdev/refs/api/krb5_get_validated_creds.html index 87bed55317c6..a92300427f4f 100644 --- a/doc/html/appdev/refs/api/krb5_get_validated_creds.html +++ b/doc/html/appdev/refs/api/krb5_get_validated_creds.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_get_validated_creds - Get validated credentials from the KDC. — 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_init_context - Create a krb5 library context." href="krb5_init_context.html" /> <link rel="prev" title="krb5_get_renewed_creds - Get renewed credential from KDC using an existing credential." href="krb5_get_renewed_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,57 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-get-validated-creds-get-validated-credentials-from-the-kdc"> + <section id="krb5-get-validated-creds-get-validated-credentials-from-the-kdc"> <h1>krb5_get_validated_creds - Get validated credentials from the KDC.<a class="headerlink" href="#krb5-get-validated-creds-get-validated-credentials-from-the-kdc" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_get_validated_creds"> -<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_get_validated_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, const char *<em> in_tkt_service</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_validated_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_get_validated_creds"> +<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_get_validated_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_tkt_service</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_get_validated_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>creds</strong> - Validated credentials</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal name</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache</p> -<p class="last"><strong>[in]</strong> <strong>in_tkt_service</strong> - Server principal string (or NULL)</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 simple"> -<li>0 Success</li> -<li>KRB5_NO_2ND_TKT Request missing second ticket</li> -<li>KRB5_NO_TKT_SUPPLIED Request did not supply a ticket</li> -<li>KRB5_PRINC_NOMATCH Requested principal and ticket do not match</li> -<li>KRB5_KDCREP_MODIFIED KDC reply did not match expectations</li> -<li>KRB5_KDCREP_SKEW Clock skew too great in KDC reply</li> +<p><strong>[in]</strong> <strong>in_tkt_service</strong> - Server principal string (or NULL)</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</p></li> +<li><p>KRB5_NO_2ND_TKT Request missing second ticket</p></li> +<li><p>KRB5_NO_TKT_SUPPLIED Request did not supply a ticket</p></li> +<li><p>KRB5_PRINC_NOMATCH Requested principal and ticket do not match</p></li> +<li><p>KRB5_KDCREP_MODIFIED KDC reply did not match expectations</p></li> +<li><p>KRB5_KDCREP_SKEW Clock skew too great in KDC reply</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function gets a validated credential using a postdated credential from <em>ccache</em> . If <em>in_tkt_service</em> is specified, it is parsed (with the realm part ignored) and used as the server principal of the credential; otherwise, the ticket-granting service is used.</p> <p>If successful, the validated credential is placed in <em>creds</em> .</p> -</div> +</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_get_validated_creds - Get validated credentials from the KDC.</a></li> @@ -155,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -162,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_context.html b/doc/html/appdev/refs/api/krb5_init_context.html index b52709b82e93..af3270108e84 100644 --- a/doc/html/appdev/refs/api/krb5_init_context.html +++ b/doc/html/appdev/refs/api/krb5_init_context.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_init_context - Create a krb5 library context. — 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_init_secure_context - Create a krb5 library context using only configuration files." href="krb5_init_secure_context.html" /> <link rel="prev" title="krb5_get_validated_creds - Get validated credentials from the KDC." href="krb5_get_validated_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-context-create-a-krb5-library-context"> + <section id="krb5-init-context-create-a-krb5-library-context"> <h1>krb5_init_context - Create a krb5 library context.<a class="headerlink" href="#krb5-init-context-create-a-krb5-library-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_context"> -<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_init_context</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_context" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_context"> +<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_init_context</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_context" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[out]</strong> <strong>context</strong> - Library context</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 simple"> -<li>0 Success</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[out]</strong> <strong>context</strong> - Library context</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>The <em>context</em> must be released by calling <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></code></a> when it is no longer needed.</p> +</dd> +</dl> +<p>The <em>context</em> must be released by calling krb5_free_context() when it is no longer needed.</p> <div class="admonition warning"> -<p class="first admonition-title">Warning</p> -<p class="last">Any program or module that needs the Kerberos code to not trust the environment must use <a class="reference internal" href="krb5_init_secure_context.html#c.krb5_init_secure_context" title="krb5_init_secure_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_secure_context()</span></code></a> , or clean out the environment.</p> -</div> +<p class="admonition-title">Warning</p> +<p>Any program or module that needs the Kerberos code to not trust the environment must use krb5_init_secure_context(), or clean out the environment.</p> </div> +</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_init_context - Create a krb5 library context.</a></li> @@ -148,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_context_profile.html b/doc/html/appdev/refs/api/krb5_init_context_profile.html index 8e2dcd4a8986..595e064c6c4c 100644 --- a/doc/html/appdev/refs/api/krb5_init_context_profile.html +++ b/doc/html/appdev/refs/api/krb5_init_context_profile.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_init_context_profile - Create a krb5 library context using a specified profile. — 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_init_creds_free - Free an initial credentials context." href="krb5_init_creds_free.html" /> <link rel="prev" title="krb5_get_time_offsets - Return the time offsets from the os context." href="krb5_get_time_offsets.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,39 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-context-profile-create-a-krb5-library-context-using-a-specified-profile"> + <section id="krb5-init-context-profile-create-a-krb5-library-context-using-a-specified-profile"> <h1>krb5_init_context_profile - Create a krb5 library context using a specified profile.<a class="headerlink" href="#krb5-init-context-profile-create-a-krb5-library-context-using-a-specified-profile" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_context_profile"> -<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_init_context_profile</code><span class="sig-paren">(</span>struct _profile_t *<em> profile</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> flags</em>, <a class="reference internal" href="../types/krb5_context.html#c.krb5_context" title="krb5_context">krb5_context</a> *<em> context</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_context_profile" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_context_profile"> +<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_init_context_profile</span></span></span><span class="sig-paren">(</span><span class="k"><span class="pre">struct</span></span><span class="w"> </span><span class="n"><span class="pre">_profile_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">profile</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_context_profile" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>profile</strong> - Profile object (NULL to create default profile)</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>profile</strong> - Profile object (NULL to create default profile)</p> <p><strong>[in]</strong> <strong>flags</strong> - Context initialization flags</p> -<p class="last"><strong>[out]</strong> <strong>context</strong> - Library context</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>context</strong> - Library context</p> +</dd> +</dl> <p>Create a context structure, optionally using a specified profile and initialization flags. If <em>profile</em> is NULL, the default profile will be created from config files. If <em>profile</em> is non-null, a copy of it will be made for the new context; the caller should still clean up its copy. Valid flag values are:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_INIT_CONTEXT_SECURE.html#KRB5_INIT_CONTEXT_SECURE" title="KRB5_INIT_CONTEXT_SECURE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_INIT_CONTEXT_SECURE</span></code></a> Ignore environment variables</li> -<li><a class="reference internal" href="../macros/KRB5_INIT_CONTEXT_KDC.html#KRB5_INIT_CONTEXT_KDC" title="KRB5_INIT_CONTEXT_KDC"><code class="xref py py-data docutils literal"><span class="pre">KRB5_INIT_CONTEXT_KDC</span></code></a> Use KDC configuration if creating profile</li> +<li><p>#KRB5_INIT_CONTEXT_SECURE Ignore environment variables</p></li> +<li><p>#KRB5_INIT_CONTEXT_KDC Use KDC configuration if creating profile</p></li> </ul> </div></blockquote> -</div> +</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_init_context_profile - Create a krb5 library context using a specified profile.</a></li> @@ -137,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -144,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_free.html b/doc/html/appdev/refs/api/krb5_init_creds_free.html index ca93919c059a..fa1a3a1305bd 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_free.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_free.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_init_creds_free - Free an initial credentials context. — 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_init_creds_get - Acquire credentials using an initial credentials context." href="krb5_init_creds_get.html" /> <link rel="prev" title="krb5_init_context_profile - Create a krb5 library context using a specified profile." href="krb5_init_context_profile.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-free-free-an-initial-credentials-context"> + <section id="krb5-init-creds-free-free-an-initial-credentials-context"> <h1>krb5_init_creds_free - Free an initial credentials context.<a class="headerlink" href="#krb5-init-creds-free-free-an-initial-credentials-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_free"> -void <code class="descname">krb5_init_creds_free</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_init_creds_free</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>ctx</strong> - Initial credentials context</p> -</td> -</tr> -</tbody> -</table> +<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>ctx</strong> - Initial credentials context</p> +</dd> +</dl> <blockquote> -<div><em>context</em> must be the same as the one passed to <a class="reference internal" href="krb5_init_creds_init.html#c.krb5_init_creds_init" title="krb5_init_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_init()</span></code></a> for this initial credentials context.</div></blockquote> -</div> +<div><p><em>context</em> must be the same as the one passed to krb5_init_creds_init() for this initial credentials context.</p> +</div></blockquote> +</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_init_creds_free - Free an initial credentials context.</a></li> @@ -131,6 +121,7 @@ void <code class="descname">krb5_init_creds_free</code><span class="sig-paren">( <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +129,8 @@ void <code class="descname">krb5_init_creds_free</code><span class="sig-paren">( <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_get.html b/doc/html/appdev/refs/api/krb5_init_creds_get.html index 4c1913264b8c..f5d821275359 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_get.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_get.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_init_creds_get - Acquire credentials using an initial credentials context. — 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_init_creds_get_creds - Retrieve acquired credentials from an initial credentials context." href="krb5_init_creds_get_creds.html" /> <link rel="prev" title="krb5_init_creds_free - Free an initial credentials context." href="krb5_init_creds_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-get-acquire-credentials-using-an-initial-credentials-context"> + <section id="krb5-init-creds-get-acquire-credentials-using-an-initial-credentials-context"> <h1>krb5_init_creds_get - Acquire credentials using an initial credentials context.<a class="headerlink" href="#krb5-init-creds-get-acquire-credentials-using-an-initial-credentials-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_get"> -<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_init_creds_get</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_get"> +<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_init_creds_get</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>ctx</strong> - Initial credentials context</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> +<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>ctx</strong> - Initial credentials context</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> -<p>This function synchronously obtains credentials using a context created by <a class="reference internal" href="krb5_init_creds_init.html#c.krb5_init_creds_init" title="krb5_init_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_init()</span></code></a> . On successful return, the credentials can be retrieved with <a class="reference internal" href="krb5_init_creds_get_creds.html#c.krb5_init_creds_get_creds" title="krb5_init_creds_get_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_get_creds()</span></code></a> .</p> +</dd> +</dl> +<p>This function synchronously obtains credentials using a context created by krb5_init_creds_init(). On successful return, the credentials can be retrieved with krb5_init_creds_get_creds().</p> <blockquote> -<div><em>context</em> must be the same as the one passed to <a class="reference internal" href="krb5_init_creds_init.html#c.krb5_init_creds_init" title="krb5_init_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_init()</span></code></a> for this initial credentials context.</div></blockquote> -</div> +<div><p><em>context</em> must be the same as the one passed to krb5_init_creds_init() for this initial credentials context.</p> +</div></blockquote> +</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_init_creds_get - Acquire credentials using an initial credentials context.</a></li> @@ -143,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_get_creds.html b/doc/html/appdev/refs/api/krb5_init_creds_get_creds.html index e32e2c86cdef..cc7320ebf146 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_get_creds.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_get_creds.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_init_creds_get_creds - Retrieve acquired credentials from an initial credentials context. — 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_init_creds_get_error - Get the last error from KDC from an initial credentials context." href="krb5_init_creds_get_error.html" /> <link rel="prev" title="krb5_init_creds_get - Acquire credentials using an initial credentials context." href="krb5_init_creds_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-get-creds-retrieve-acquired-credentials-from-an-initial-credentials-context"> + <section id="krb5-init-creds-get-creds-retrieve-acquired-credentials-from-an-initial-credentials-context"> <h1>krb5_init_creds_get_creds - Retrieve acquired credentials from an initial credentials context.<a class="headerlink" href="#krb5-init-creds-get-creds-retrieve-acquired-credentials-from-an-initial-credentials-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_get_creds"> -<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_init_creds_get_creds</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_get_creds"> +<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_init_creds_get_creds</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[out]</strong> <strong>creds</strong> - Acquired credentials</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>creds</strong> - Acquired credentials</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> -<p>This function copies the acquired initial credentials from <em>ctx</em> into <em>creds</em> , after the successful completion of <a class="reference internal" href="krb5_init_creds_get.html#c.krb5_init_creds_get" title="krb5_init_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_get()</span></code></a> or <a class="reference internal" href="krb5_init_creds_step.html#c.krb5_init_creds_step" title="krb5_init_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_step()</span></code></a> . Use <a class="reference internal" href="krb5_free_cred_contents.html#c.krb5_free_cred_contents" title="krb5_free_cred_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_cred_contents()</span></code></a> to free <em>creds</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function copies the acquired initial credentials from <em>ctx</em> into <em>creds</em> , after the successful completion of krb5_init_creds_get() or krb5_init_creds_step(). Use krb5_free_cred_contents() to free <em>creds</em> when it is no longer needed.</p> +</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_init_creds_get_creds - Retrieve acquired credentials from an initial credentials context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_get_error.html b/doc/html/appdev/refs/api/krb5_init_creds_get_error.html index e6df1f789f90..42ae200c0753 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_get_error.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_get_error.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_init_creds_get_error - Get the last error from KDC from an initial credentials context. — 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_init_creds_get_times - Retrieve ticket times from an initial credentials context." href="krb5_init_creds_get_times.html" /> <link rel="prev" title="krb5_init_creds_get_creds - Retrieve acquired credentials from an initial credentials context." href="krb5_init_creds_get_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-get-error-get-the-last-error-from-kdc-from-an-initial-credentials-context"> + <section id="krb5-init-creds-get-error-get-the-last-error-from-kdc-from-an-initial-credentials-context"> <h1>krb5_init_creds_get_error - Get the last error from KDC from an initial credentials context.<a class="headerlink" href="#krb5-init-creds-get-error-get-the-last-error-from-kdc-from-an-initial-credentials-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_get_error"> -<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_init_creds_get_error</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> **<em> error</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_error" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_get_error"> +<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_init_creds_get_error</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">error</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_error" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[out]</strong> <strong>error</strong> - Error from KDC, or NULL if none was received</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>error</strong> - Error from KDC, or NULL if none was received</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> -</div> +</dd> +</dl> +</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_init_creds_get_error - Get the last error from KDC from an initial credentials context.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_get_times.html b/doc/html/appdev/refs/api/krb5_init_creds_get_times.html index 08684e0e3371..1f17b9e3672b 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_get_times.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_get_times.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_init_creds_get_times - Retrieve ticket times from an initial credentials context. — 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_init_creds_init - Create a context for acquiring initial credentials." href="krb5_init_creds_init.html" /> <link rel="prev" title="krb5_init_creds_get_error - Get the last error from KDC from an initial credentials context." href="krb5_init_creds_get_error.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-get-times-retrieve-ticket-times-from-an-initial-credentials-context"> + <section id="krb5-init-creds-get-times-retrieve-ticket-times-from-an-initial-credentials-context"> <h1>krb5_init_creds_get_times - Retrieve ticket times from an initial credentials context.<a class="headerlink" href="#krb5-init-creds-get-times-retrieve-ticket-times-from-an-initial-credentials-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_get_times"> -<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_init_creds_get_times</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_ticket_times.html#c.krb5_ticket_times" title="krb5_ticket_times">krb5_ticket_times</a> *<em> times</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_times" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_get_times"> +<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_init_creds_get_times</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_ticket_times.html#c.krb5_ticket_times" title="krb5_ticket_times"><span class="n"><span class="pre">krb5_ticket_times</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">times</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_get_times" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[out]</strong> <strong>times</strong> - Ticket times for acquired credentials</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>times</strong> - Ticket times for acquired credentials</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> -<p>The initial credentials context must have completed obtaining credentials via either <a class="reference internal" href="krb5_init_creds_get.html#c.krb5_init_creds_get" title="krb5_init_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_get()</span></code></a> or <a class="reference internal" href="krb5_init_creds_step.html#c.krb5_init_creds_step" title="krb5_init_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_step()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>The initial credentials context must have completed obtaining credentials via either krb5_init_creds_get() or krb5_init_creds_step().</p> +</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_init_creds_get_times - Retrieve ticket times from an initial credentials context.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_init.html b/doc/html/appdev/refs/api/krb5_init_creds_init.html index ff712d5ba939..ace909aef663 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_init.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_init.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_init_creds_init - Create a context for acquiring initial credentials. — 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_init_creds_set_keytab - Specify a keytab to use for acquiring initial credentials." href="krb5_init_creds_set_keytab.html" /> <link rel="prev" title="krb5_init_creds_get_times - Retrieve ticket times from an initial credentials context." href="krb5_init_creds_get_times.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-init-create-a-context-for-acquiring-initial-credentials"> + <section id="krb5-init-creds-init-create-a-context-for-acquiring-initial-credentials"> <h1>krb5_init_creds_init - Create a context for acquiring initial credentials.<a class="headerlink" href="#krb5-init-creds-init-create-a-context-for-acquiring-initial-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_init"> -<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_init_creds_init</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_prompter_fct.html#c.krb5_prompter_fct" title="krb5_prompter_fct">krb5_prompter_fct</a><em> prompter</em>, void *<em> data</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a><em> start_time</em>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt">krb5_get_init_creds_opt</a> *<em> options</em>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a> *<em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_init"> +<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_init_creds_init</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_prompter_fct.html#c.krb5_prompter_fct" title="krb5_prompter_fct"><span class="n"><span class="pre">krb5_prompter_fct</span></span></a><span class="w"> </span><span class="n"><span class="pre">prompter</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="n"><span class="pre">start_time</span></span>, <a class="reference internal" href="../types/krb5_get_init_creds_opt.html#c.krb5_get_init_creds_opt" title="krb5_get_init_creds_opt"><span class="n"><span class="pre">krb5_get_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>client</strong> - Client principal to get initial creds for</p> <p><strong>[in]</strong> <strong>prompter</strong> - Prompter callback</p> <p><strong>[in]</strong> <strong>data</strong> - Prompter callback argument</p> <p><strong>[in]</strong> <strong>start_time</strong> - Time when credentials become valid (0 for now)</p> <p><strong>[in]</strong> <strong>options</strong> - Options structure (NULL for default)</p> -<p class="last"><strong>[out]</strong> <strong>ctx</strong> - New initial credentials context</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>ctx</strong> - New initial credentials context</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> -<p>This function creates a new context for acquiring initial credentials. Use <a class="reference internal" href="krb5_init_creds_free.html#c.krb5_init_creds_free" title="krb5_init_creds_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_free()</span></code></a> to free <em>ctx</em> when it is no longer needed.</p> -<p>Any subsequent calls to <a class="reference internal" href="krb5_init_creds_step.html#c.krb5_init_creds_step" title="krb5_init_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_step()</span></code></a> , <a class="reference internal" href="krb5_init_creds_get.html#c.krb5_init_creds_get" title="krb5_init_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_get()</span></code></a> , or <a class="reference internal" href="krb5_init_creds_free.html#c.krb5_init_creds_free" title="krb5_init_creds_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_free()</span></code></a> for this initial credentials context must use the same <em>context</em> argument as the one passed to this function.</p> -</div> +</dd> +</dl> +<p>This function creates a new context for acquiring initial credentials. Use krb5_init_creds_free() to free <em>ctx</em> when it is no longer needed.</p> +<p>Any subsequent calls to krb5_init_creds_step(), krb5_init_creds_get(), or krb5_init_creds_free() for this initial credentials context must use the same <em>context</em> argument as the one passed to this function.</p> +</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_init_creds_init - Create a context for acquiring initial credentials.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_set_keytab.html b/doc/html/appdev/refs/api/krb5_init_creds_set_keytab.html index c1b41a7af84f..359f226921ce 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_set_keytab.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_set_keytab.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_init_creds_set_keytab - Specify a keytab to use for acquiring initial credentials. — 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_init_creds_set_password - Set a password for acquiring initial credentials." href="krb5_init_creds_set_password.html" /> <link rel="prev" title="krb5_init_creds_init - Create a context for acquiring initial credentials." href="krb5_init_creds_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-set-keytab-specify-a-keytab-to-use-for-acquiring-initial-credentials"> + <section id="krb5-init-creds-set-keytab-specify-a-keytab-to-use-for-acquiring-initial-credentials"> <h1>krb5_init_creds_set_keytab - Specify a keytab to use for acquiring initial credentials.<a class="headerlink" href="#krb5-init-creds-set-keytab-specify-a-keytab-to-use-for-acquiring-initial-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_set_keytab"> -<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_init_creds_set_keytab</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_keytab" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_set_keytab"> +<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_init_creds_set_keytab</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_keytab" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[in]</strong> <strong>keytab</strong> - Key table handle</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>keytab</strong> - Key table handle</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 supplies a keytab containing the client key for an initial credentials request.</p> -</div> +</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_init_creds_set_keytab - Specify a keytab to use for acquiring initial credentials.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_set_password.html b/doc/html/appdev/refs/api/krb5_init_creds_set_password.html index d7b54ec38aec..1c7238716e71 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_set_password.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_set_password.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_init_creds_set_password - Set a password for acquiring initial credentials. — 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_init_creds_set_service - Specify a service principal for acquiring initial credentials." href="krb5_init_creds_set_service.html" /> <link rel="prev" title="krb5_init_creds_set_keytab - Specify a keytab to use for acquiring initial credentials." href="krb5_init_creds_set_keytab.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-set-password-set-a-password-for-acquiring-initial-credentials"> + <section id="krb5-init-creds-set-password-set-a-password-for-acquiring-initial-credentials"> <h1>krb5_init_creds_set_password - Set a password for acquiring initial credentials.<a class="headerlink" href="#krb5-init-creds-set-password-set-a-password-for-acquiring-initial-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_set_password"> -<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_init_creds_set_password</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, const char *<em> password</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_set_password"> +<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_init_creds_set_password</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">password</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[in]</strong> <strong>password</strong> - Password</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>password</strong> - Password</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 supplies a password to be used to construct the client key for an initial credentials request.</p> -</div> +</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_init_creds_set_password - Set a password for acquiring initial credentials.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_set_service.html b/doc/html/appdev/refs/api/krb5_init_creds_set_service.html index 2b344053c94c..0aacd833fc7e 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_set_service.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_set_service.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_init_creds_set_service - Specify a service principal for acquiring initial credentials. — 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_init_creds_step - Get the next KDC request for acquiring initial credentials." href="krb5_init_creds_step.html" /> <link rel="prev" title="krb5_init_creds_set_password - Set a password for acquiring initial credentials." href="krb5_init_creds_set_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-set-service-specify-a-service-principal-for-acquiring-initial-credentials"> + <section id="krb5-init-creds-set-service-specify-a-service-principal-for-acquiring-initial-credentials"> <h1>krb5_init_creds_set_service - Specify a service principal for acquiring initial credentials.<a class="headerlink" href="#krb5-init-creds-set-service-specify-a-service-principal-for-acquiring-initial-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_set_service"> -<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_init_creds_set_service</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, const char *<em> service</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_service" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_set_service"> +<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_init_creds_set_service</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">service</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_set_service" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> -<p class="last"><strong>[in]</strong> <strong>service</strong> - Service principal string</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>service</strong> - Service principal string</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 supplies a service principal string to acquire initial credentials for instead of the default krbtgt service. <em>service</em> is parsed as a principal name; any realm part is ignored.</p> -</div> +</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_init_creds_set_service - Specify a service principal for acquiring initial credentials.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_creds_step.html b/doc/html/appdev/refs/api/krb5_init_creds_step.html index c4cae421ac30..41d643c37f2d 100644 --- a/doc/html/appdev/refs/api/krb5_init_creds_step.html +++ b/doc/html/appdev/refs/api/krb5_init_creds_step.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_init_creds_step - Get the next KDC request for acquiring initial credentials. — 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_init_keyblock - Initialize an empty krb5_keyblock ." href="krb5_init_keyblock.html" /> <link rel="prev" title="krb5_init_creds_set_service - Specify a service principal for acquiring initial credentials." href="krb5_init_creds_set_service.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-creds-step-get-the-next-kdc-request-for-acquiring-initial-credentials"> + <section id="krb5-init-creds-step-get-the-next-kdc-request-for-acquiring-initial-credentials"> <h1>krb5_init_creds_step - Get the next KDC request for acquiring initial credentials.<a class="headerlink" href="#krb5-init-creds-step-get-the-next-kdc-request-for-acquiring-initial-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_creds_step"> -<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_init_creds_step</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context">krb5_init_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> out</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> realm</em>, unsigned int *<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_step" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_creds_step"> +<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_init_creds_step</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>, <a class="reference internal" href="../types/krb5_init_creds_context.html#c.krb5_init_creds_context" title="krb5_init_creds_context"><span class="n"><span class="pre">krb5_init_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</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">in</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">out</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">realm</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_creds_step" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Initial credentials context</p> <p><strong>[in]</strong> <strong>in</strong> - KDC response (empty on the first call)</p> <p><strong>[out]</strong> <strong>out</strong> - Next KDC request</p> <p><strong>[out]</strong> <strong>realm</strong> - Realm for next KDC request</p> -<p class="last"><strong>[out]</strong> <strong>flags</strong> - Output flags</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>flags</strong> - Output flags</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 constructs the next KDC request in an initial credential exchange, allowing the caller to control the transport of KDC requests and replies. On the first call, <em>in</em> should be set to an empty buffer; on subsequent calls, it should be set to the KDC’s reply to the previous request.</p> -<p>If more requests are needed, <em>flags</em> will be set to <a class="reference internal" href="../macros/KRB5_INIT_CREDS_STEP_FLAG_CONTINUE.html#KRB5_INIT_CREDS_STEP_FLAG_CONTINUE" title="KRB5_INIT_CREDS_STEP_FLAG_CONTINUE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_INIT_CREDS_STEP_FLAG_CONTINUE</span></code></a> and the next request will be placed in <em>out</em> . If no more requests are needed, <em>flags</em> will not contain <a class="reference internal" href="../macros/KRB5_INIT_CREDS_STEP_FLAG_CONTINUE.html#KRB5_INIT_CREDS_STEP_FLAG_CONTINUE" title="KRB5_INIT_CREDS_STEP_FLAG_CONTINUE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_INIT_CREDS_STEP_FLAG_CONTINUE</span></code></a> and <em>out</em> will be empty.</p> +<p>If more requests are needed, <em>flags</em> will be set to #KRB5_INIT_CREDS_STEP_FLAG_CONTINUE and the next request will be placed in <em>out</em> . If no more requests are needed, <em>flags</em> will not contain #KRB5_INIT_CREDS_STEP_FLAG_CONTINUE and <em>out</em> will be empty.</p> <p>If this function returns <strong>KRB5KRB_ERR_RESPONSE_TOO_BIG</strong> , the caller should transmit the next request using TCP rather than UDP. If this function returns any other error, the initial credential exchange has failed.</p> <blockquote> -<div><em>context</em> must be the same as the one passed to <a class="reference internal" href="krb5_init_creds_init.html#c.krb5_init_creds_init" title="krb5_init_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_init()</span></code></a> for this initial credentials context.</div></blockquote> -</div> +<div><p><em>context</em> must be the same as the one passed to krb5_init_creds_init() for this initial credentials context.</p> +</div></blockquote> +</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_init_creds_step - Get the next KDC request for acquiring initial credentials.</a></li> @@ -149,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_keyblock.html b/doc/html/appdev/refs/api/krb5_init_keyblock.html index a5e38633dc7b..5b41041a9739 100644 --- a/doc/html/appdev/refs/api/krb5_init_keyblock.html +++ b/doc/html/appdev/refs/api/krb5_init_keyblock.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_init_keyblock - Initialize an empty krb5_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> <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_is_referral_realm - Check for a match with KRB5_REFERRAL_REALM." href="krb5_is_referral_realm.html" /> <link rel="prev" title="krb5_init_creds_step - Get the next KDC request for acquiring initial credentials." href="krb5_init_creds_step.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-keyblock-initialize-an-empty-krb5-keyblock"> + <section id="krb5-init-keyblock-initialize-an-empty-krb5-keyblock"> <h1>krb5_init_keyblock - Initialize an empty krb5_keyblock .<a class="headerlink" href="#krb5-init-keyblock-initialize-an-empty-krb5-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_keyblock"> -<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_init_keyblock</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, size_t<em> length</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_keyblock" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_keyblock"> +<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_init_keyblock</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>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">length</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_keyblock" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enctype</strong> - Encryption type</p> <p><strong>[in]</strong> <strong>length</strong> - Length of keyblock (or 0)</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - New keyblock structure</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>out</strong> - New keyblock structure</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> -<p>Initialize a new keyblock and allocate storage for the contents of the key. It is legal to pass in a length of 0, in which case contents are left unallocated. Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>out</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Initialize a new keyblock and allocate storage for the contents of the key. It is legal to pass in a length of 0, in which case contents are left unallocated. Use krb5_free_keyblock() to free <em>out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If <em>length</em> is set to 0, contents are left unallocated.</p> -</div> +<p class="admonition-title">Note</p> +<p>If <em>length</em> is set to 0, contents are left unallocated.</p> </div> +</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_init_keyblock - Initialize an empty krb5_keyblock .</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_random_key.html b/doc/html/appdev/refs/api/krb5_init_random_key.html index 633d6ae62a5d..2af5648fd9e1 100644 --- a/doc/html/appdev/refs/api/krb5_init_random_key.html +++ b/doc/html/appdev/refs/api/krb5_init_random_key.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_init_random_key — 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_kt_free_entry" href="krb5_kt_free_entry.html" /> <link rel="prev" title="krb5_get_init_creds_opt_init" href="krb5_get_init_creds_opt_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-random-key"> + <section id="krb5-init-random-key"> <h1>krb5_init_random_key<a class="headerlink" href="#krb5-init-random-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_random_key"> -<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_init_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</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_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a> *<em> ptr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_random_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_random_key"> +<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_init_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</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_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ptr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_random_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> <p><strong>keyblock</strong></p> -<p class="last"><strong>ptr</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>ptr</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_init_random_key</a></li> @@ -132,6 +121,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_init_secure_context.html b/doc/html/appdev/refs/api/krb5_init_secure_context.html index 7f1a380039e4..fdfdac9513a9 100644 --- a/doc/html/appdev/refs/api/krb5_init_secure_context.html +++ b/doc/html/appdev/refs/api/krb5_init_secure_context.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_init_secure_context - Create a krb5 library context using only configuration files. — 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_is_config_principal - Test whether a principal is a configuration principal." href="krb5_is_config_principal.html" /> <link rel="prev" title="krb5_init_context - Create a krb5 library context." href="krb5_init_context.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-init-secure-context-create-a-krb5-library-context-using-only-configuration-files"> + <section id="krb5-init-secure-context-create-a-krb5-library-context-using-only-configuration-files"> <h1>krb5_init_secure_context - Create a krb5 library context using only configuration files.<a class="headerlink" href="#krb5-init-secure-context-create-a-krb5-library-context-using-only-configuration-files" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_init_secure_context"> -<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_init_secure_context</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_secure_context" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_init_secure_context"> +<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_init_secure_context</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">context</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_init_secure_context" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[out]</strong> <strong>context</strong> - Library context</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 simple"> -<li>0 Success</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[out]</strong> <strong>context</strong> - Library context</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Create a context structure, using only system configuration files. All information passed through the environment variables is ignored.</p> -<p>The <em>context</em> must be released by calling <a class="reference internal" href="krb5_free_context.html#c.krb5_free_context" title="krb5_free_context"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_context()</span></code></a> when it is no longer needed.</p> -</div> +<p>The <em>context</em> must be released by calling krb5_free_context() when it is no longer needed.</p> +</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_init_secure_context - Create a krb5 library context using only configuration files.</a></li> @@ -145,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_is_config_principal.html b/doc/html/appdev/refs/api/krb5_is_config_principal.html index 039abc4573e7..f9da536edff5 100644 --- a/doc/html/appdev/refs/api/krb5_is_config_principal.html +++ b/doc/html/appdev/refs/api/krb5_is_config_principal.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_is_config_principal - Test whether a principal is a configuration principal. — 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_is_thread_safe - Test whether the Kerberos library was built with multithread support." href="krb5_is_thread_safe.html" /> <link rel="prev" title="krb5_init_secure_context - Create a krb5 library context using only configuration files." href="krb5_init_secure_context.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-is-config-principal-test-whether-a-principal-is-a-configuration-principal"> + <section id="krb5-is-config-principal-test-whether-a-principal-is-a-configuration-principal"> <h1>krb5_is_config_principal - Test whether a principal is a configuration principal.<a class="headerlink" href="#krb5-is-config-principal-test-whether-a-principal-is-a-configuration-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_is_config_principal"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_is_config_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_config_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_is_config_principal"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_is_config_principal</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_config_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>principal</strong> - Principal to check</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if the principal is a configuration principal (generated part of krb5_cc_set_config() ); FALSE otherwise.</li> +<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>principal</strong> - Principal to check</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the principal is a configuration principal (generated part of krb5_cc_set_config()); FALSE otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_is_config_principal - Test whether a principal is a configuration principal.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_is_referral_realm.html b/doc/html/appdev/refs/api/krb5_is_referral_realm.html index 0c18a859b1a0..490230ec9a33 100644 --- a/doc/html/appdev/refs/api/krb5_is_referral_realm.html +++ b/doc/html/appdev/refs/api/krb5_is_referral_realm.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_is_referral_realm - Check for a match with KRB5_REFERRAL_REALM. — 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_kdc_sign_ticket - Sign a PAC, possibly including a ticket signature." href="krb5_kdc_sign_ticket.html" /> <link rel="prev" title="krb5_init_keyblock - Initialize an empty krb5_keyblock ." href="krb5_init_keyblock.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-is-referral-realm-check-for-a-match-with-krb5-referral-realm"> + <section id="krb5-is-referral-realm-check-for-a-match-with-krb5-referral-realm"> <h1>krb5_is_referral_realm - Check for a match with KRB5_REFERRAL_REALM.<a class="headerlink" href="#krb5-is-referral-realm-check-for-a-match-with-krb5-referral-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_is_referral_realm"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_is_referral_realm</code><span class="sig-paren">(</span>const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> r</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_referral_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_is_referral_realm"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_is_referral_realm</span></span></span><span class="sig-paren">(</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">r</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_referral_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>r</strong> - Realm to check</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if r is zero-length, FALSE otherwise</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>r</strong> - Realm to check</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if r is zero-length, FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_is_referral_realm - Check for a match with KRB5_REFERRAL_REALM.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_is_thread_safe.html b/doc/html/appdev/refs/api/krb5_is_thread_safe.html index 1e0c8c9900bc..76b425d60f95 100644 --- a/doc/html/appdev/refs/api/krb5_is_thread_safe.html +++ b/doc/html/appdev/refs/api/krb5_is_thread_safe.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_is_thread_safe - Test whether the Kerberos library was built with multithread support. — 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_kt_close - Close a key table handle." href="krb5_kt_close.html" /> <link rel="prev" title="krb5_is_config_principal - Test whether a principal is a configuration principal." href="krb5_is_config_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,40 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-is-thread-safe-test-whether-the-kerberos-library-was-built-with-multithread-support"> + <section id="krb5-is-thread-safe-test-whether-the-kerberos-library-was-built-with-multithread-support"> <h1>krb5_is_thread_safe - Test whether the Kerberos library was built with multithread support.<a class="headerlink" href="#krb5-is-thread-safe-test-whether-the-kerberos-library-was-built-with-multithread-support" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_is_thread_safe"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_is_thread_safe</code><span class="sig-paren">(</span>void<em> None</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_thread_safe" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_is_thread_safe"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_is_thread_safe</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_is_thread_safe" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>None</strong></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>TRUE if the library is threadsafe; FALSE otherwise</li> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>None</strong></p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the library is threadsafe; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_is_thread_safe - Test whether the Kerberos library was built with multithread support.</a></li> @@ -138,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -145,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_create_key.html b/doc/html/appdev/refs/api/krb5_k_create_key.html index 016d72606ad6..bcdf38693421 100644 --- a/doc/html/appdev/refs/api/krb5_k_create_key.html +++ b/doc/html/appdev/refs/api/krb5_k_create_key.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_k_create_key - Create a krb5_key from the enctype and key data in a 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> <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_k_decrypt - Decrypt data using a key (operates on opaque key)." href="krb5_k_decrypt.html" /> <link rel="prev" title="krb5_free_tgt_creds - Free an array of credential structures." href="krb5_free_tgt_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-create-key-create-a-krb5-key-from-the-enctype-and-key-data-in-a-keyblock"> + <section id="krb5-k-create-key-create-a-krb5-key-from-the-enctype-and-key-data-in-a-keyblock"> <h1>krb5_k_create_key - Create a krb5_key from the enctype and key data in a keyblock.<a class="headerlink" href="#krb5-k-create-key-create-a-krb5-key-from-the-enctype-and-key-data-in-a-keyblock" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_create_key"> -<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_k_create_key</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_data</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a> *<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_create_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_create_key"> +<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_k_create_key</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_data</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_create_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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_data</strong> - Keyblock</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - Opaque key</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 - KRB5_BAD_ENCTYPE</li> +<p><strong>[out]</strong> <strong>out</strong> - Opaque key</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 - KRB5_BAD_ENCTYPE</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>The reference count on a key <em>out</em> is set to 1. Use <a class="reference internal" href="krb5_k_free_key.html#c.krb5_k_free_key" title="krb5_k_free_key"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_free_key()</span></code></a> to free <em>out</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>The reference count on a key <em>out</em> is set to 1. Use krb5_k_free_key() to free <em>out</em> when it is no longer needed.</p> +</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_k_create_key - Create a krb5_key from the enctype and key data in a keyblock.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_decrypt.html b/doc/html/appdev/refs/api/krb5_k_decrypt.html index dba2f72e4f09..70b2c7c76ff5 100644 --- a/doc/html/appdev/refs/api/krb5_k_decrypt.html +++ b/doc/html/appdev/refs/api/krb5_k_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_k_decrypt - Decrypt data using a key (operates on opaque key). — 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_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_decrypt_iov.html" /> <link rel="prev" title="krb5_k_create_key - Create a krb5_key from the enctype and key data in a keyblock." href="krb5_k_create_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-decrypt-decrypt-data-using-a-key-operates-on-opaque-key"> + <section id="krb5-k-decrypt-decrypt-data-using-a-key-operates-on-opaque-key"> <h1>krb5_k_decrypt - Decrypt data using a key (operates on opaque key).<a class="headerlink" href="#krb5-k-decrypt-decrypt-data-using-a-key-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_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_k_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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_k_decrypt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_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_k_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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_k_decrypt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> <div class="admonition note"> -<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="krb5_c_decrypt.html#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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_k_decrypt - Decrypt data using a key (operates on opaque key).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_decrypt_iov.html b/doc/html/appdev/refs/api/krb5_k_decrypt_iov.html index 5cbef1ada42a..5a5bd2028658 100644 --- a/doc/html/appdev/refs/api/krb5_k_decrypt_iov.html +++ b/doc/html/appdev/refs/api/krb5_k_decrypt_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_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key). — 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_k_encrypt - Encrypt data using a key (operates on opaque key)." href="krb5_k_encrypt.html" /> <link rel="prev" title="krb5_k_decrypt - Decrypt data using a key (operates on opaque key)." href="krb5_k_decrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-opaque-key"> + <section id="krb5-k-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-opaque-key"> <h1>krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key).<a class="headerlink" href="#krb5-k-decrypt-iov-decrypt-data-in-place-supporting-aead-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_decrypt_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_k_decrypt_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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>, <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_k_decrypt_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_decrypt_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_k_decrypt_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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>, <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_k_decrypt_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[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 decrypts the data block <em>data</em> and stores the output in-place. 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. The caller must allocate the right number of krb5_crypto_iov structures before calling into this API.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_k_encrypt_iov.html#c.krb5_k_encrypt_iov" title="krb5_k_encrypt_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_encrypt_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_k_encrypt_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">On return from a <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> 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_decrypt_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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key).</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_encrypt.html b/doc/html/appdev/refs/api/krb5_k_encrypt.html index 265f2a517a36..c4c484f7933f 100644 --- a/doc/html/appdev/refs/api/krb5_k_encrypt.html +++ b/doc/html/appdev/refs/api/krb5_k_encrypt.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_k_encrypt - Encrypt data using a key (operates on opaque key). — 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_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_encrypt_iov.html" /> <link rel="prev" title="krb5_k_decrypt_iov - Decrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_decrypt_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-encrypt-encrypt-data-using-a-key-operates-on-opaque-key"> + <section id="krb5-k-encrypt-encrypt-data-using-a-key-operates-on-opaque-key"> <h1>krb5_k_encrypt - Encrypt data using a key (operates on opaque key).<a class="headerlink" href="#krb5-k-encrypt-encrypt-data-using-a-key-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_encrypt"> -<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_k_encrypt</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> input</em>, <a class="reference internal" href="../types/krb5_enc_data.html#c.krb5_enc_data" title="krb5_enc_data">krb5_enc_data</a> *<em> output</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_encrypt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_encrypt"> +<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_k_encrypt</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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_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">input</span></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">output</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_encrypt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Data to be encrypted</p> -<p class="last"><strong>[out]</strong> <strong>output</strong> - Encrypted 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> - Encrypted 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 encrypts the data block <em>input</em> and stores the output into <em>output</em> . 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.</p> <div class="admonition note"> -<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 (using <a class="reference internal" href="krb5_c_encrypt_length.html#c.krb5_c_encrypt_length" title="krb5_c_encrypt_length"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_encrypt_length()</span></code></a> to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</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 (using krb5_c_encrypt_length() to determine the amount of space needed). <em>output->length</em> will be set to the actual length of the ciphertext.</p> </div> +</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_k_encrypt - Encrypt data using a key (operates on opaque key).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_encrypt_iov.html b/doc/html/appdev/refs/api/krb5_k_encrypt_iov.html index bf0c5c9d1c17..744a2602415c 100644 --- a/doc/html/appdev/refs/api/krb5_k_encrypt_iov.html +++ b/doc/html/appdev/refs/api/krb5_k_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_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key). — 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_k_free_key - Decrement the reference count on a key and free it if it hits zero." href="krb5_k_free_key.html" /> <link rel="prev" title="krb5_k_encrypt - Encrypt data using a key (operates on opaque key)." href="krb5_k_encrypt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-opaque-key"> + <section id="krb5-k-encrypt-iov-encrypt-data-in-place-supporting-aead-operates-on-opaque-key"> <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> -<dl class="function"> -<dt id="c.krb5_k_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_k_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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>, <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_k_encrypt_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_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_k_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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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>, <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_k_encrypt_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[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>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> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_k_decrypt_iov.html#c.krb5_k_decrypt_iov" title="krb5_k_decrypt_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_decrypt_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_k_decrypt_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">On return from a <a class="reference internal" href="krb5_c_encrypt_iov.html#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> </div> </div> </div> <div class="sidebar"> + <h2>On this page</h2> <ul> <li><a class="reference internal" href="#">krb5_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key).</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_free_key.html b/doc/html/appdev/refs/api/krb5_k_free_key.html index fbcf84f320ec..e05b5d47ca34 100644 --- a/doc/html/appdev/refs/api/krb5_k_free_key.html +++ b/doc/html/appdev/refs/api/krb5_k_free_key.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_k_free_key - Decrement the reference count on a key and free it if it hits zero. — 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_k_key_enctype - Retrieve the enctype of a krb5_key structure." href="krb5_k_key_enctype.html" /> <link rel="prev" title="krb5_k_encrypt_iov - Encrypt data in place supporting AEAD (operates on opaque key)." href="krb5_k_encrypt_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-free-key-decrement-the-reference-count-on-a-key-and-free-it-if-it-hits-zero"> + <section id="krb5-k-free-key-decrement-the-reference-count-on-a-key-and-free-it-if-it-hits-zero"> <h1>krb5_k_free_key - Decrement the reference count on a key and free it if it hits zero.<a class="headerlink" href="#krb5-k-free-key-decrement-the-reference-count-on-a-key-and-free-it-if-it-hits-zero" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_free_key"> -void <code class="descname">krb5_k_free_key</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_free_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_free_key"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_k_free_key</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_free_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>key</strong></p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>key</strong></p> +</dd> +</dl> +</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_k_free_key - Decrement the reference count on a key and free it if it hits zero.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_k_free_key</code><span class="sig-paren">(</spa <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_k_free_key</code><span class="sig-paren">(</spa <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_key_enctype.html b/doc/html/appdev/refs/api/krb5_k_key_enctype.html index 4de27c11c8bc..97c4c1e4e5ca 100644 --- a/doc/html/appdev/refs/api/krb5_k_key_enctype.html +++ b/doc/html/appdev/refs/api/krb5_k_key_enctype.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_k_key_enctype - Retrieve the enctype of a krb5_key structure. — 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_k_key_keyblock - Retrieve a copy of the keyblock from a krb5_key structure." href="krb5_k_key_keyblock.html" /> <link rel="prev" 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" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-key-enctype-retrieve-the-enctype-of-a-krb5-key-structure"> + <section id="krb5-k-key-enctype-retrieve-the-enctype-of-a-krb5-key-structure"> <h1>krb5_k_key_enctype - Retrieve the enctype of a krb5_key structure.<a class="headerlink" href="#krb5-k-key-enctype-retrieve-the-enctype-of-a-krb5-key-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_key_enctype"> -<a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> <code class="descname">krb5_k_key_enctype</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_key_enctype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_key_enctype"> +<a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_k_key_enctype</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_key_enctype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>key</strong></p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>key</strong></p> +</dd> +</dl> +</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_k_key_enctype - Retrieve the enctype of a krb5_key structure.</a></li> @@ -129,6 +118,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_key_keyblock.html b/doc/html/appdev/refs/api/krb5_k_key_keyblock.html index 73ce59904090..a32ab7a506af 100644 --- a/doc/html/appdev/refs/api/krb5_k_key_keyblock.html +++ b/doc/html/appdev/refs/api/krb5_k_key_keyblock.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_k_key_keyblock - Retrieve a copy of the keyblock from a krb5_key structure. — 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_k_make_checksum - Compute a checksum (operates on opaque key)." href="krb5_k_make_checksum.html" /> <link rel="prev" title="krb5_k_key_enctype - Retrieve the enctype of a krb5_key structure." href="krb5_k_key_enctype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-key-keyblock-retrieve-a-copy-of-the-keyblock-from-a-krb5-key-structure"> + <section id="krb5-k-key-keyblock-retrieve-a-copy-of-the-keyblock-from-a-krb5-key-structure"> <h1>krb5_k_key_keyblock - Retrieve a copy of the keyblock from a krb5_key structure.<a class="headerlink" href="#krb5-k-key-keyblock-retrieve-a-copy-of-the-keyblock-from-a-krb5-key-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_key_keyblock"> -<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_k_key_keyblock</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> key_data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_key_keyblock" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_key_keyblock"> +<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_k_key_keyblock</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">key_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_key_keyblock" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>key</strong></p> -<p class="last"><strong>key_data</strong></p> -</td> -</tr> -</tbody> -</table> -</div> +<p><strong>key_data</strong></p> +</dd> +</dl> +</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_k_key_keyblock - Retrieve a copy of the keyblock from a krb5_key structure.</a></li> @@ -130,6 +119,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_make_checksum.html b/doc/html/appdev/refs/api/krb5_k_make_checksum.html index 0657e5740a70..3b5e70d8ca97 100644 --- a/doc/html/appdev/refs/api/krb5_k_make_checksum.html +++ b/doc/html/appdev/refs/api/krb5_k_make_checksum.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_k_make_checksum - Compute a checksum (operates on opaque key). — 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_k_make_checksum_iov - Fill in a checksum element in IOV array (operates on opaque key)" href="krb5_k_make_checksum_iov.html" /> <link rel="prev" title="krb5_k_key_keyblock - Retrieve a copy of the keyblock from a krb5_key structure." href="krb5_k_key_keyblock.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-make-checksum-compute-a-checksum-operates-on-opaque-key"> + <section id="krb5-k-make-checksum-compute-a-checksum-operates-on-opaque-key"> <h1>krb5_k_make_checksum - Compute a checksum (operates on opaque key).<a class="headerlink" href="#krb5-k-make-checksum-compute-a-checksum-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_make_checksum"> -<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_k_make_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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> input</em>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> cksum</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_make_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_make_checksum"> +<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_k_make_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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">input</span></span>, <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksum</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_make_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>input</strong> - Input data</p> -<p class="last"><strong>[out]</strong> <strong>cksum</strong> - Generated checksum</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>cksum</strong> - Generated checksum</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> -<p>This function computes a checksum of type <em>cksumtype</em> over <em>input</em> , using <em>key</em> if the checksum type is a keyed checksum. If <em>cksumtype</em> is 0 and <em>key</em> is non-null, the checksum type will be the mandatory-to-implement checksum type for the key’s encryption type. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type. The newly created <em>cksum</em> must be released by calling <a class="reference internal" href="krb5_free_checksum_contents.html#c.krb5_free_checksum_contents" title="krb5_free_checksum_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_checksum_contents()</span></code></a> when it is no longer needed.</p> +</dd> +</dl> +<p>This function computes a checksum of type <em>cksumtype</em> over <em>input</em> , using <em>key</em> if the checksum type is a keyed checksum. If <em>cksumtype</em> is 0 and <em>key</em> is non-null, the checksum type will be the mandatory-to-implement checksum type for the key’s encryption type. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type. The newly created <em>cksum</em> must be released by calling krb5_free_checksum_contents() when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_c_verify_checksum.html#c.krb5_c_verify_checksum" title="krb5_c_verify_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_verify_checksum()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_c_verify_checksum()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_c_make_checksum.html#c.krb5_c_make_checksum" title="krb5_c_make_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_make_checksum()</span></code></a> , but operates on opaque <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_c_make_checksum(), but operates on opaque <em>key</em> .</p> </div> +</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_k_make_checksum - Compute a checksum (operates on opaque key).</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_make_checksum_iov.html b/doc/html/appdev/refs/api/krb5_k_make_checksum_iov.html index 652d77cdb7bd..8222f67600bd 100644 --- a/doc/html/appdev/refs/api/krb5_k_make_checksum_iov.html +++ b/doc/html/appdev/refs/api/krb5_k_make_checksum_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_k_make_checksum_iov - Fill in a checksum element in IOV array (operates on opaque key) — 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_k_prf - Generate enctype-specific pseudo-random bytes (operates on opaque key)." href="krb5_k_prf.html" /> <link rel="prev" title="krb5_k_make_checksum - Compute a checksum (operates on opaque key)." href="krb5_k_make_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-opaque-key"> + <section id="krb5-k-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-opaque-key"> <h1>krb5_k_make_checksum_iov - Fill in a checksum element in IOV array (operates on opaque key)<a class="headerlink" href="#krb5-k-make-checksum-iov-fill-in-a-checksum-element-in-iov-array-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_make_checksum_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_k_make_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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>, <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_k_make_checksum_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_make_checksum_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_k_make_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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>, <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_k_make_checksum_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>data</strong> - IOV array</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> -<p>Create a checksum in the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> element over <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_DATA.html#KRB5_CRYPTO_TYPE_DATA" title="KRB5_CRYPTO_TYPE_DATA"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_DATA</span></code></a> and <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_SIGN_ONLY.html#KRB5_CRYPTO_TYPE_SIGN_ONLY" title="KRB5_CRYPTO_TYPE_SIGN_ONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_SIGN_ONLY</span></code></a> chunks in <em>data</em> . Only the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> region is modified.</p> +</dd> +</dl> +<p>Create a checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element over #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY chunks in <em>data</em> . Only the #KRB5_CRYPTO_TYPE_CHECKSUM region is modified.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_k_verify_checksum_iov.html#c.krb5_k_verify_checksum_iov" title="krb5_k_verify_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_verify_checksum_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_k_verify_checksum_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_c_make_checksum_iov.html#c.krb5_c_make_checksum_iov" title="krb5_c_make_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_make_checksum_iov()</span></code></a> , but operates on opaque <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_c_make_checksum_iov(), but operates on opaque <em>key</em> .</p> </div> +</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_k_make_checksum_iov - Fill in a checksum element in IOV array (operates on opaque key)</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_prf.html b/doc/html/appdev/refs/api/krb5_k_prf.html index 065fc131d36a..12a3387b605d 100644 --- a/doc/html/appdev/refs/api/krb5_k_prf.html +++ b/doc/html/appdev/refs/api/krb5_k_prf.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_k_prf - Generate enctype-specific pseudo-random bytes (operates on opaque key). — 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_k_reference_key - Increment the reference count on a key." href="krb5_k_reference_key.html" /> <link rel="prev" title="krb5_k_make_checksum_iov - Fill in a checksum element in IOV array (operates on opaque key)" href="krb5_k_make_checksum_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-prf-generate-enctype-specific-pseudo-random-bytes-operates-on-opaque-key"> + <section id="krb5-k-prf-generate-enctype-specific-pseudo-random-bytes-operates-on-opaque-key"> <h1>krb5_k_prf - Generate enctype-specific pseudo-random bytes (operates on opaque key).<a class="headerlink" href="#krb5-k-prf-generate-enctype-specific-pseudo-random-bytes-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_prf"> -<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_k_prf</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_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_k_prf" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_prf"> +<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_k_prf</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</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">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_k_prf" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Key</p> <p><strong>[in]</strong> <strong>input</strong> - Input data</p> -<p class="last"><strong>[out]</strong> <strong>output</strong> - Output 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> - Output 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 selects a pseudo-random function based on <em>key</em> and computes its value over <em>input</em> , placing the result into <em>output</em> . The caller must preinitialize <em>output</em> and allocate space for the result.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_c_prf.html#c.krb5_c_prf" title="krb5_c_prf"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_prf()</span></code></a> , but operates on opaque <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_c_prf(), but operates on opaque <em>key</em> .</p> </div> +</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_k_prf - Generate enctype-specific pseudo-random bytes (operates on opaque key).</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_reference_key.html b/doc/html/appdev/refs/api/krb5_k_reference_key.html index 3272029c9a78..8b271f6783b0 100644 --- a/doc/html/appdev/refs/api/krb5_k_reference_key.html +++ b/doc/html/appdev/refs/api/krb5_k_reference_key.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_k_reference_key - Increment the reference count on a key. — 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_k_verify_checksum - Verify a checksum (operates on opaque key)." href="krb5_k_verify_checksum.html" /> <link rel="prev" title="krb5_k_prf - Generate enctype-specific pseudo-random bytes (operates on opaque key)." href="krb5_k_prf.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,31 +52,29 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-reference-key-increment-the-reference-count-on-a-key"> + <section id="krb5-k-reference-key-increment-the-reference-count-on-a-key"> <h1>krb5_k_reference_key - Increment the reference count on a key.<a class="headerlink" href="#krb5-k-reference-key-increment-the-reference-count-on-a-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_reference_key"> -void <code class="descname">krb5_k_reference_key</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</a><em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_reference_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_reference_key"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_k_reference_key</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_reference_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>key</strong></p> -</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>key</strong></p> +</dd> +</dl> +</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_k_reference_key - Increment the reference count on a key.</a></li> @@ -129,6 +118,7 @@ void <code class="descname">krb5_k_reference_key</code><span class="sig-paren">( <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -136,8 +126,8 @@ void <code class="descname">krb5_k_reference_key</code><span class="sig-paren">( <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_verify_checksum.html b/doc/html/appdev/refs/api/krb5_k_verify_checksum.html index f652032a444c..7990872aa6da 100644 --- a/doc/html/appdev/refs/api/krb5_k_verify_checksum.html +++ b/doc/html/appdev/refs/api/krb5_k_verify_checksum.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_k_verify_checksum - Verify a checksum (operates on opaque key). — 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_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key)." href="krb5_k_verify_checksum_iov.html" /> <link rel="prev" title="krb5_k_reference_key - Increment the reference count on a key." href="krb5_k_reference_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-verify-checksum-verify-a-checksum-operates-on-opaque-key"> + <section id="krb5-k-verify-checksum-verify-a-checksum-operates-on-opaque-key"> <h1>krb5_k_verify_checksum - Verify a checksum (operates on opaque key).<a class="headerlink" href="#krb5-k-verify-checksum-verify-a-checksum-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_verify_checksum"> -<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_k_verify_checksum</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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> data</em>, const <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> cksum</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> *<em> valid</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_verify_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_verify_checksum"> +<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_k_verify_checksum</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>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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">data</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksum</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_verify_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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 for a keyed checksum</p> <p><strong>[in]</strong> <strong>usage</strong> - <em>key</em> usage</p> <p><strong>[in]</strong> <strong>data</strong> - Data to be used to compute a new checksum using <em>key</em> to compare <em>cksum</em> against</p> <p><strong>[in]</strong> <strong>cksum</strong> - Checksum to be verified</p> -<p class="last"><strong>[out]</strong> <strong>valid</strong> - Non-zero for success, zero for failure</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>valid</strong> - Non-zero for success, zero for failure</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 verifies that <em>cksum</em> is a valid checksum for <em>data</em> . If the checksum type of <em>cksum</em> is a keyed checksum, <em>key</em> is used to verify the checksum. If the checksum type in <em>cksum</em> is 0 and <em>key</em> is not NULL, the mandatory checksum type for <em>key</em> will be used. The actual checksum key will be derived from <em>key</em> and <em>usage</em> if key derivation is specified for the checksum type.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_c_verify_checksum.html#c.krb5_c_verify_checksum" title="krb5_c_verify_checksum"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_verify_checksum()</span></code></a> , but operates on opaque <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_c_verify_checksum(), but operates on opaque <em>key</em> .</p> </div> +</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_k_verify_checksum - Verify a checksum (operates on opaque key).</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_k_verify_checksum_iov.html b/doc/html/appdev/refs/api/krb5_k_verify_checksum_iov.html index 25fd40465dbf..4e95e0cd276e 100644 --- a/doc/html/appdev/refs/api/krb5_k_verify_checksum_iov.html +++ b/doc/html/appdev/refs/api/krb5_k_verify_checksum_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_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key). — 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_recvauth - Server function for sendauth protocol." href="krb5_recvauth.html" /> <link rel="prev" title="krb5_k_verify_checksum - Verify a checksum (operates on opaque key)." href="krb5_k_verify_checksum.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,56 +52,50 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-k-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-opaque-key"> + <section id="krb5-k-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-opaque-key"> <h1>krb5_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key).<a class="headerlink" href="#krb5-k-verify-checksum-iov-validate-a-checksum-element-in-iov-array-operates-on-opaque-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_k_verify_checksum_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_k_verify_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> cksumtype</em>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key">krb5_key</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_crypto_iov.html#c.krb5_crypto_iov" title="krb5_crypto_iov">krb5_crypto_iov</a> *<em> data</em>, size_t<em> num_data</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> *<em> valid</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_verify_checksum_iov" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_k_verify_checksum_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_k_verify_checksum_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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">cksumtype</span></span>, <a class="reference internal" href="../types/krb5_key.html#c.krb5_key" title="krb5_key"><span class="n"><span class="pre">krb5_key</span></span></a><span class="w"> </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_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>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">valid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_k_verify_checksum_iov" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>cksumtype</strong> - Checksum type (0 for mandatory type)</p> <p><strong>[in]</strong> <strong>key</strong> - Encryption key for a keyed checksum</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>data</strong> - IOV array</p> <p><strong>[in]</strong> <strong>num_data</strong> - Size of <em>data</em></p> -<p class="last"><strong>[out]</strong> <strong>valid</strong> - Non-zero for success, zero for failure</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>valid</strong> - Non-zero for success, zero for failure</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> -<p>Confirm that the checksum in the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_CHECKSUM.html#KRB5_CRYPTO_TYPE_CHECKSUM" title="KRB5_CRYPTO_TYPE_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_CHECKSUM</span></code></a> element is a valid checksum of the <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_DATA.html#KRB5_CRYPTO_TYPE_DATA" title="KRB5_CRYPTO_TYPE_DATA"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_DATA</span></code></a> and <a class="reference internal" href="../macros/KRB5_CRYPTO_TYPE_SIGN_ONLY.html#KRB5_CRYPTO_TYPE_SIGN_ONLY" title="KRB5_CRYPTO_TYPE_SIGN_ONLY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_CRYPTO_TYPE_SIGN_ONLY</span></code></a> regions in the iov.</p> +</dd> +</dl> +<p>Confirm that the checksum in the #KRB5_CRYPTO_TYPE_CHECKSUM element is a valid checksum of the #KRB5_CRYPTO_TYPE_DATA and #KRB5_CRYPTO_TYPE_SIGN_ONLY regions in the iov.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_k_make_checksum_iov.html#c.krb5_k_make_checksum_iov" title="krb5_k_make_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_k_make_checksum_iov()</span></code></a></p> +<p class="admonition-title">See also</p> +<p>krb5_k_make_checksum_iov()</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function is similar to <a class="reference internal" href="krb5_c_verify_checksum_iov.html#c.krb5_c_verify_checksum_iov" title="krb5_c_verify_checksum_iov"><code class="xref c c-func docutils literal"><span class="pre">krb5_c_verify_checksum_iov()</span></code></a> , but operates on opaque <em>key</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>This function is similar to krb5_c_verify_checksum_iov(), but operates on opaque <em>key</em> .</p> </div> +</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_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key).</a></li> @@ -154,6 +139,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -161,8 +147,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kdc_sign_ticket.html b/doc/html/appdev/refs/api/krb5_kdc_sign_ticket.html index 2fa06fe46e7b..9430e8296612 100644 --- a/doc/html/appdev/refs/api/krb5_kdc_sign_ticket.html +++ b/doc/html/appdev/refs/api/krb5_kdc_sign_ticket.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_kdc_sign_ticket - Sign a PAC, possibly including a ticket signature. — 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_kdc_verify_ticket - Verify a PAC, possibly including ticket signature." href="krb5_kdc_verify_ticket.html" /> <link rel="prev" title="krb5_is_referral_realm - Check for a match with KRB5_REFERRAL_REALM." href="krb5_is_referral_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kdc-sign-ticket-sign-a-pac-possibly-including-a-ticket-signature"> + <section id="krb5-kdc-sign-ticket-sign-a-pac-possibly-including-a-ticket-signature"> <h1>krb5_kdc_sign_ticket - Sign a PAC, possibly including a ticket signature.<a class="headerlink" href="#krb5-kdc-sign-ticket-sign-a-pac-possibly-including-a-ticket-signature" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kdc_sign_ticket"> -<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_kdc_sign_ticket</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>, <a class="reference internal" href="../types/krb5_enc_tkt_part.html#c.krb5_enc_tkt_part" title="krb5_enc_tkt_part">krb5_enc_tkt_part</a> *<em> enc_tkt</em>, const <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> server_princ</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> client_princ</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> with_realm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kdc_sign_ticket" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kdc_sign_ticket"> +<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_kdc_sign_ticket</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>, <a class="reference internal" href="../types/krb5_enc_tkt_part.html#c.krb5_enc_tkt_part" title="krb5_enc_tkt_part"><span class="n"><span class="pre">krb5_enc_tkt_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">enc_tkt</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server_princ</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client_princ</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">server</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">privsvr</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">with_realm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kdc_sign_ticket" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enc_tkt</strong> - The ticket for the signature</p> <p><strong>[in]</strong> <strong>pac</strong> - PAC handle</p> <p><strong>[in]</strong> <strong>server_princ</strong> - Canonical ticket server name</p> <p><strong>[in]</strong> <strong>client_princ</strong> - PAC_CLIENT_INFO principal (or NULL)</p> <p><strong>[in]</strong> <strong>server</strong> - Key for server checksum</p> <p><strong>[in]</strong> <strong>privsvr</strong> - Key for KDC and ticket checksum</p> -<p class="last"><strong>[in]</strong> <strong>with_realm</strong> - If true, include the realm of <em>principal</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 on success, otherwise - Kerberos error codes</li> +<p><strong>[in]</strong> <strong>with_realm</strong> - If true, include the realm of <em>principal</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 on success, otherwise - Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Sign <em>pac</em> using the keys <em>server</em> and <em>privsvr</em> . Include a ticket signature over <em>enc_tkt</em> if <em>server_princ</em> is not a TGS or kadmin/changepw principal name. Add the signed PAC’s encoding to the authorization data of <em>enc_tkt</em> in the first slot, wrapped in an AD-IF-RELEVANT container. If <em>client_princ</em> is non-null, add a PAC_CLIENT_INFO buffer, including the realm if <em>with_realm</em> is true.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.20</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.20</p> </div> +</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_kdc_sign_ticket - Sign a PAC, possibly including a ticket signature.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kdc_verify_ticket.html b/doc/html/appdev/refs/api/krb5_kdc_verify_ticket.html index a90e31d406a9..1e2d6ea2dd8d 100644 --- a/doc/html/appdev/refs/api/krb5_kdc_verify_ticket.html +++ b/doc/html/appdev/refs/api/krb5_kdc_verify_ticket.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_kdc_verify_ticket - Verify a PAC, possibly including ticket signature. — 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_kt_add_entry - Add a new entry to a key table." href="krb5_kt_add_entry.html" /> <link rel="prev" title="krb5_kdc_sign_ticket - Sign a PAC, possibly including a ticket signature." href="krb5_kdc_sign_ticket.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,56 +52,50 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kdc-verify-ticket-verify-a-pac-possibly-including-ticket-signature"> + <section id="krb5-kdc-verify-ticket-verify-a-pac-possibly-including-ticket-signature"> <h1>krb5_kdc_verify_ticket - Verify a PAC, possibly including ticket signature.<a class="headerlink" href="#krb5-kdc-verify-ticket-verify-a-pac-possibly-including-ticket-signature" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kdc_verify_ticket"> -<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_kdc_verify_ticket</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_enc_tkt_part.html#c.krb5_enc_tkt_part" title="krb5_enc_tkt_part">krb5_enc_tkt_part</a> *<em> enc_tkt</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> server_princ</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr</em>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a> *<em> pac_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kdc_verify_ticket" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kdc_verify_ticket"> +<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_kdc_verify_ticket</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_enc_tkt_part.html#c.krb5_enc_tkt_part" title="krb5_enc_tkt_part"><span class="n"><span class="pre">krb5_enc_tkt_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">enc_tkt</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server_princ</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">server</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">privsvr</span></span>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pac_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kdc_verify_ticket" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enc_tkt</strong> - Ticket enc-part, possibly containing a PAC</p> <p><strong>[in]</strong> <strong>server_princ</strong> - Canonicalized name of ticket server</p> <p><strong>[in]</strong> <strong>server</strong> - Key to validate server checksum (or NULL)</p> <p><strong>[in]</strong> <strong>privsvr</strong> - Key to validate KDC checksum (or NULL)</p> -<p class="last"><strong>[out]</strong> <strong>pac_out</strong> - Verified PAC (NULL if no PAC included)</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>pac_out</strong> - Verified PAC (NULL if no PAC included)</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>If a PAC is present in <em>enc_tkt</em> , verify its signatures. If <em>privsvr</em> is not NULL and <em>server_princ</em> is not a krbtgt or kadmin/changepw service, require a ticket signature over <em>enc_tkt</em> in addition to the KDC signature. Place the verified PAC in <em>pac_out</em> . If an invalid PAC signature is found, return an error matching the Windows KDC protocol code for that condition as closely as possible.</p> <p>If no PAC is present in <em>enc_tkt</em> , set <em>pac_out</em> to NULL and return successfully.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function does not validate the PAC_CLIENT_INFO buffer. If a specific value is expected, the caller can make a separate call to <a class="reference internal" href="krb5_pac_verify_ext.html#c.krb5_pac_verify_ext" title="krb5_pac_verify_ext"><code class="xref c c-func docutils literal"><span class="pre">krb5_pac_verify_ext()</span></code></a> with a principal but no keys.</p> +<p class="admonition-title">Note</p> +<p>This function does not validate the PAC_CLIENT_INFO buffer. If a specific value is expected, the caller can make a separate call to krb5_pac_verify_ext() with a principal but no keys.</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.20</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.20</p> </div> +</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_kdc_verify_ticket - Verify a PAC, possibly including ticket signature.</a></li> @@ -154,6 +139,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -161,8 +147,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_add_entry.html b/doc/html/appdev/refs/api/krb5_kt_add_entry.html index c33e84c008f4..8bc7aa6842f4 100644 --- a/doc/html/appdev/refs/api/krb5_kt_add_entry.html +++ b/doc/html/appdev/refs/api/krb5_kt_add_entry.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_kt_add_entry - Add a new entry to a key table. — 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_kt_end_seq_get - Release a keytab cursor." href="krb5_kt_end_seq_get.html" /> <link rel="prev" title="krb5_kdc_verify_ticket - Verify a PAC, possibly including ticket signature." href="krb5_kdc_verify_ticket.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-add-entry-add-a-new-entry-to-a-key-table"> + <section id="krb5-kt-add-entry-add-a-new-entry-to-a-key-table"> <h1>krb5_kt_add_entry - Add a new entry to a key table.<a class="headerlink" href="#krb5-kt-add-entry-add-a-new-entry-to-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_add_entry"> -<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_kt_add_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> id</em>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_add_entry" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_add_entry"> +<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_kt_add_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">id</span></span>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_add_entry" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>id</strong> - Key table handle</p> -<p class="last"><strong>[in]</strong> <strong>entry</strong> - Entry to be added</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 simple"> -<li>0 Success</li> -<li>ENOMEM Insufficient memory</li> -<li>KRB5_KT_NOWRITE Key table is not writeable</li> +<p><strong>[in]</strong> <strong>entry</strong> - Entry to be added</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</p></li> +<li><p>ENOMEM Insufficient memory</p></li> +<li><p>KRB5_KT_NOWRITE Key table is not writeable</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_kt_add_entry - Add a new entry to a key table.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_client_default.html b/doc/html/appdev/refs/api/krb5_kt_client_default.html index 6e70778b89f5..d26d5e99b94a 100644 --- a/doc/html/appdev/refs/api/krb5_kt_client_default.html +++ b/doc/html/appdev/refs/api/krb5_kt_client_default.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_kt_client_default - Resolve the default client key table. — 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_kt_default - Resolve the default key table." href="krb5_kt_default.html" /> <link rel="prev" title="krb5_kt_close - Close a key table handle." href="krb5_kt_close.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-client-default-resolve-the-default-client-key-table"> + <section id="krb5-kt-client-default-resolve-the-default-client-key-table"> <h1>krb5_kt_client_default - Resolve the default client key table.<a class="headerlink" href="#krb5-kt-client-default-resolve-the-default-client-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_client_default"> -<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_kt_client_default</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a> *<em> keytab_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_client_default" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_client_default"> +<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_kt_client_default</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">keytab_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_client_default" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>keytab_out</strong> - Key table handle</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 simple"> -<li>0 Success</li> +<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>[out]</strong> <strong>keytab_out</strong> - Key table handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Fill <em>keytab_out</em> with a handle to the default client key table.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_kt_client_default - Resolve the default client key table.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_close.html b/doc/html/appdev/refs/api/krb5_kt_close.html index a2a878f6b8a5..0e9e2cd0ec25 100644 --- a/doc/html/appdev/refs/api/krb5_kt_close.html +++ b/doc/html/appdev/refs/api/krb5_kt_close.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_kt_close - Close a key table handle. — 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_kt_client_default - Resolve the default client key table." href="krb5_kt_client_default.html" /> <link rel="prev" title="krb5_is_thread_safe - Test whether the Kerberos library was built with multithread support." href="krb5_is_thread_safe.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-close-close-a-key-table-handle"> + <section id="krb5-kt-close-close-a-key-table-handle"> <h1>krb5_kt_close - Close a key table handle.<a class="headerlink" href="#krb5-kt-close-close-a-key-table-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_close"> -<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_kt_close</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_close" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_close"> +<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_kt_close</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_close" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>keytab</strong> - Key table handle</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 None</li> +<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>keytab</strong> - Key table handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 None</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_kt_close - Close a key table handle.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_default.html b/doc/html/appdev/refs/api/krb5_kt_default.html index 368be6a7beda..0f94a7f8a219 100644 --- a/doc/html/appdev/refs/api/krb5_kt_default.html +++ b/doc/html/appdev/refs/api/krb5_kt_default.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_kt_default - Resolve the default key table. — 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_kt_default_name - Get the default key table name." href="krb5_kt_default_name.html" /> <link rel="prev" title="krb5_kt_client_default - Resolve the default client key table." href="krb5_kt_client_default.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-default-resolve-the-default-key-table"> + <section id="krb5-kt-default-resolve-the-default-key-table"> <h1>krb5_kt_default - Resolve the default key table.<a class="headerlink" href="#krb5-kt-default-resolve-the-default-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_default"> -<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_kt_default</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a> *<em> id</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_default" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_default"> +<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_kt_default</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">id</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_default" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>id</strong> - Key table handle</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 simple"> -<li>0 Success</li> +<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>[out]</strong> <strong>id</strong> - Key table handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Set <em>id</em> to a handle to the default key table. The key table is not opened.</p> -</div> +</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_kt_default - Resolve the default key table.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_default_name.html b/doc/html/appdev/refs/api/krb5_kt_default_name.html index e11a29527476..8384b1193bd5 100644 --- a/doc/html/appdev/refs/api/krb5_kt_default_name.html +++ b/doc/html/appdev/refs/api/krb5_kt_default_name.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_kt_default_name - Get the default key table name. — 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_kt_dup - Duplicate keytab handle." href="krb5_kt_dup.html" /> <link rel="prev" title="krb5_kt_default - Resolve the default key table." href="krb5_kt_default.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-default-name-get-the-default-key-table-name"> + <section id="krb5-kt-default-name-get-the-default-key-table-name"> <h1>krb5_kt_default_name - Get the default key table name.<a class="headerlink" href="#krb5-kt-default-name-get-the-default-key-table-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_default_name"> -<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_kt_default_name</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>, char *<em> name</em>, int<em> name_size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_default_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_default_name"> +<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_kt_default_name</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="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">name_size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_default_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>name</strong> - Default key table name</p> -<p class="last"><strong>[in]</strong> <strong>name_size</strong> - Space available in <em>name</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 simple"> -<li>0 Success</li> -<li>KRB5_CONFIG_NOTENUFSPACE Buffer is too short</li> +<p><strong>[in]</strong> <strong>name_size</strong> - Space available in <em>name</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</p></li> +<li><p>KRB5_CONFIG_NOTENUFSPACE Buffer is too short</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Fill <em>name</em> with the name of the default key table for <em>context</em> .</p> -</div> +</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_kt_default_name - Get the default key table name.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_dup.html b/doc/html/appdev/refs/api/krb5_kt_dup.html index 93de16a230a4..cf8806f9644d 100644 --- a/doc/html/appdev/refs/api/krb5_kt_dup.html +++ b/doc/html/appdev/refs/api/krb5_kt_dup.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_kt_dup - Duplicate keytab handle. — 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_kt_get_name - Get a key table name." href="krb5_kt_get_name.html" /> <link rel="prev" title="krb5_kt_default_name - Get the default key table name." href="krb5_kt_default_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-dup-duplicate-keytab-handle"> + <section id="krb5-kt-dup-duplicate-keytab-handle"> <h1>krb5_kt_dup - Duplicate keytab handle.<a class="headerlink" href="#krb5-kt-dup-duplicate-keytab-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_dup"> -<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_kt_dup</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> in</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a> *<em> out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_dup" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_dup"> +<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_kt_dup</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">in</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_dup" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>in</strong> - Key table handle to be duplicated</p> -<p class="last"><strong>[out]</strong> <strong>out</strong> - Key table handle</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>out</strong> - Key table handle</p> +</dd> +</dl> <p>Create a new handle referring to the same key table as <em>in</em> . The new handle and <em>in</em> can be closed independently.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.12</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.12</p> </div> +</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_kt_dup - Duplicate keytab handle.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_end_seq_get.html b/doc/html/appdev/refs/api/krb5_kt_end_seq_get.html index 154b4abbad13..95019bb274f4 100644 --- a/doc/html/appdev/refs/api/krb5_kt_end_seq_get.html +++ b/doc/html/appdev/refs/api/krb5_kt_end_seq_get.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_kt_end_seq_get - Release a keytab cursor. — 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_kt_get_entry - Get an entry from a key table." href="krb5_kt_get_entry.html" /> <link rel="prev" title="krb5_kt_add_entry - Add a new entry to a key table." href="krb5_kt_add_entry.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-end-seq-get-release-a-keytab-cursor"> + <section id="krb5-kt-end-seq-get-release-a-keytab-cursor"> <h1>krb5_kt_end_seq_get - Release a keytab cursor.<a class="headerlink" href="#krb5-kt-end-seq-get-release-a-keytab-cursor" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_end_seq_get"> -<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_kt_end_seq_get</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor">krb5_kt_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_end_seq_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_end_seq_get"> +<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_kt_end_seq_get</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor"><span class="n"><span class="pre">krb5_kt_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_end_seq_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keytab</strong> - Key table handle</p> -<p class="last"><strong>[out]</strong> <strong>cursor</strong> - Cursor</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>cursor</strong> - Cursor</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function should be called to release the cursor created by <a class="reference internal" href="krb5_kt_start_seq_get.html#c.krb5_kt_start_seq_get" title="krb5_kt_start_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_kt_start_seq_get()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>This function should be called to release the cursor created by krb5_kt_start_seq_get().</p> +</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_kt_end_seq_get - Release a keytab cursor.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_free_entry.html b/doc/html/appdev/refs/api/krb5_kt_free_entry.html index 46f01e4c7c42..cc4af5dc9bdf 100644 --- a/doc/html/appdev/refs/api/krb5_kt_free_entry.html +++ b/doc/html/appdev/refs/api/krb5_kt_free_entry.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_kt_free_entry — 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_random_key" href="krb5_random_key.html" /> <link rel="prev" title="krb5_init_random_key" href="krb5_init_random_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-free-entry"> + <section id="krb5-kt-free-entry"> <h1>krb5_kt_free_entry<a class="headerlink" href="#krb5-kt-free-entry" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_free_entry"> -<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_kt_free_entry</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>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_free_entry" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_free_entry"> +<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_kt_free_entry</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>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_free_entry" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> -<p class="last"><strong>entry</strong></p> -</td> -</tr> -</tbody> -</table> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> +<p><strong>entry</strong></p> +</dd> +</dl> <p>DEPRECATED Use krb5_free_keytab_entry_contents instead.</p> -</div> +</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_kt_free_entry</a></li> @@ -130,6 +119,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_get_entry.html b/doc/html/appdev/refs/api/krb5_kt_get_entry.html index e0348fac364e..7f6ed3d056c3 100644 --- a/doc/html/appdev/refs/api/krb5_kt_get_entry.html +++ b/doc/html/appdev/refs/api/krb5_kt_get_entry.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_kt_get_entry - Get an entry from a key table. — 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_kt_have_content - Check if a keytab exists and contains entries." href="krb5_kt_have_content.html" /> <link rel="prev" title="krb5_kt_end_seq_get - Release a keytab cursor." href="krb5_kt_end_seq_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-get-entry-get-an-entry-from-a-key-table"> + <section id="krb5-kt-get-entry-get-an-entry-from-a-key-table"> <h1>krb5_kt_get_entry - Get an entry from a key table.<a class="headerlink" href="#krb5-kt-get-entry-get-an-entry-from-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_get_entry"> -<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_kt_get_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, <a class="reference internal" href="../types/krb5_kvno.html#c.krb5_kvno" title="krb5_kvno">krb5_kvno</a><em> vno</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_entry" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_get_entry"> +<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_kt_get_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <a class="reference internal" href="../types/krb5_kvno.html#c.krb5_kvno" title="krb5_kvno"><span class="n"><span class="pre">krb5_kvno</span></span></a><span class="w"> </span><span class="n"><span class="pre">vno</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_entry" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keytab</strong> - Key table handle</p> <p><strong>[in]</strong> <strong>principal</strong> - Principal name</p> <p><strong>[in]</strong> <strong>vno</strong> - Key version number (0 for highest available)</p> <p><strong>[in]</strong> <strong>enctype</strong> - Encryption type (0 zero for any enctype)</p> -<p class="last"><strong>[out]</strong> <strong>entry</strong> - Returned entry from key table</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</li> -<li>Kerberos error codes on failure</li> +<p><strong>[out]</strong> <strong>entry</strong> - Returned entry from key table</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</p></li> +<li><p>Kerberos error codes on failure</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Retrieve an entry from a key table which matches the <em>keytab</em> , <em>principal</em> , <em>vno</em> , and <em>enctype</em> . If <em>vno</em> is zero, retrieve the highest-numbered kvno matching the other fields. If <em>enctype</em> is 0, match any enctype.</p> -<p>Use <a class="reference internal" href="krb5_free_keytab_entry_contents.html#c.krb5_free_keytab_entry_contents" title="krb5_free_keytab_entry_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keytab_entry_contents()</span></code></a> to free <em>entry</em> when it is no longer needed.</p> +<p>Use krb5_free_keytab_entry_contents() to free <em>entry</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If <em>vno</em> is zero, the function retrieves the highest-numbered-kvno entry that matches the specified principal.</p> -</div> +<p class="admonition-title">Note</p> +<p>If <em>vno</em> is zero, the function retrieves the highest-numbered-kvno entry that matches the specified principal.</p> </div> +</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_kt_get_entry - Get an entry from a key table.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_get_name.html b/doc/html/appdev/refs/api/krb5_kt_get_name.html index 56cc0773cd3e..58d6f2c2a5ec 100644 --- a/doc/html/appdev/refs/api/krb5_kt_get_name.html +++ b/doc/html/appdev/refs/api/krb5_kt_get_name.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_kt_get_name - Get a key table name. — 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_kt_get_type - Return the type of a key table." href="krb5_kt_get_type.html" /> <link rel="prev" title="krb5_kt_dup - Duplicate keytab handle." href="krb5_kt_dup.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-get-name-get-a-key-table-name"> + <section id="krb5-kt-get-name-get-a-key-table-name"> <h1>krb5_kt_get_name - Get a key table name.<a class="headerlink" href="#krb5-kt-get-name-get-a-key-table-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_get_name"> -<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_kt_get_name</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, char *<em> name</em>, unsigned int<em> namelen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_get_name"> +<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_kt_get_name</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">namelen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keytab</strong> - Key table handle</p> <p><strong>[out]</strong> <strong>name</strong> - Key table name</p> -<p class="last"><strong>[in]</strong> <strong>namelen</strong> - Maximum length to fill in name</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 simple"> -<li>0 Success</li> -<li>KRB5_KT_NAME_TOOLONG Key table name does not fit in namelen bytes</li> +<p><strong>[in]</strong> <strong>namelen</strong> - Maximum length to fill in name</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</p></li> +<li><p>KRB5_KT_NAME_TOOLONG Key table name does not fit in namelen bytes</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Fill <em>name</em> with the name of <em>keytab</em> including the type and delimiter.</p> -</div> +</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_kt_get_name - Get a key table name.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_get_type.html b/doc/html/appdev/refs/api/krb5_kt_get_type.html index 17e693b1fb68..f1ab854e6941 100644 --- a/doc/html/appdev/refs/api/krb5_kt_get_type.html +++ b/doc/html/appdev/refs/api/krb5_kt_get_type.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_kt_get_type - Return the type of a key table. — 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_kt_resolve - Get a handle for a key table." href="krb5_kt_resolve.html" /> <link rel="prev" title="krb5_kt_get_name - Get a key table name." href="krb5_kt_get_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-get-type-return-the-type-of-a-key-table"> + <section id="krb5-kt-get-type-return-the-type-of-a-key-table"> <h1>krb5_kt_get_type - Return the type of a key table.<a class="headerlink" href="#krb5-kt-get-type-return-the-type-of-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_get_type"> -const char * <code class="descname">krb5_kt_get_type</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_type" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_get_type"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_kt_get_type</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_get_type" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>keytab</strong> - Key table handle</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>The type of a key table as an alias that must not be modified or freed by the caller.</li> +<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>keytab</strong> - Key table handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>The type of a key table as an alias that must not be modified or freed by the caller.</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_kt_get_type - Return the type of a key table.</a></li> @@ -140,6 +125,7 @@ const char * <code class="descname">krb5_kt_get_type</code><span class="sig-pare <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ const char * <code class="descname">krb5_kt_get_type</code><span class="sig-pare <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_have_content.html b/doc/html/appdev/refs/api/krb5_kt_have_content.html index c3c1e9d46ffc..a61872bf635c 100644 --- a/doc/html/appdev/refs/api/krb5_kt_have_content.html +++ b/doc/html/appdev/refs/api/krb5_kt_have_content.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_kt_have_content - Check if a keytab exists and contains entries. — 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_kt_next_entry - Retrieve the next entry from the key table." href="krb5_kt_next_entry.html" /> <link rel="prev" title="krb5_kt_get_entry - Get an entry from a key table." href="krb5_kt_get_entry.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-have-content-check-if-a-keytab-exists-and-contains-entries"> + <section id="krb5-kt-have-content-check-if-a-keytab-exists-and-contains-entries"> <h1>krb5_kt_have_content - Check if a keytab exists and contains entries.<a class="headerlink" href="#krb5-kt-have-content-check-if-a-keytab-exists-and-contains-entries" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_have_content"> -<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_kt_have_content</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_have_content" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_have_content"> +<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_kt_have_content</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_have_content" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>keytab</strong> - Key table handle</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 Keytab exists and contains entries</li> -<li>KRB5_KT_NOTFOUND Keytab does not contain entries</li> +<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>keytab</strong> - Key table handle</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 Keytab exists and contains entries</p></li> +<li><p>KRB5_KT_NOTFOUND Keytab does not contain entries</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_kt_have_content - Check if a keytab exists and contains entries.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_next_entry.html b/doc/html/appdev/refs/api/krb5_kt_next_entry.html index fd50d3b922cd..de69878a4a41 100644 --- a/doc/html/appdev/refs/api/krb5_kt_next_entry.html +++ b/doc/html/appdev/refs/api/krb5_kt_next_entry.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_kt_next_entry - Retrieve the next entry from the key table. — 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_kt_read_service_key - Retrieve a service key from a key table." href="krb5_kt_read_service_key.html" /> <link rel="prev" title="krb5_kt_have_content - Check if a keytab exists and contains entries." href="krb5_kt_have_content.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-next-entry-retrieve-the-next-entry-from-the-key-table"> + <section id="krb5-kt-next-entry-retrieve-the-next-entry-from-the-key-table"> <h1>krb5_kt_next_entry - Retrieve the next entry from the key table.<a class="headerlink" href="#krb5-kt-next-entry-retrieve-the-next-entry-from-the-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_next_entry"> -<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_kt_next_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor">krb5_kt_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_next_entry" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_next_entry"> +<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_kt_next_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor"><span class="n"><span class="pre">krb5_kt_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_next_entry" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keytab</strong> - Key table handle</p> <p><strong>[out]</strong> <strong>entry</strong> - Returned key table entry</p> -<p class="last"><strong>[in]</strong> <strong>cursor</strong> - Key table cursor</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 simple"> -<li>0 Success</li> -<li>KRB5_KT_END - if the last entry was reached</li> +<p><strong>[in]</strong> <strong>cursor</strong> - Key table cursor</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</p></li> +<li><p>KRB5_KT_END - if the last entry was reached</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Return the next sequential entry in <em>keytab</em> and advance <em>cursor</em> . Callers must release the returned entry with <a class="reference internal" href="krb5_kt_free_entry.html#c.krb5_kt_free_entry" title="krb5_kt_free_entry"><code class="xref c c-func docutils literal"><span class="pre">krb5_kt_free_entry()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>Return the next sequential entry in <em>keytab</em> and advance <em>cursor</em> . Callers must release the returned entry with krb5_kt_free_entry().</p> +</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_kt_next_entry - Retrieve the next entry from the key table.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_read_service_key.html b/doc/html/appdev/refs/api/krb5_kt_read_service_key.html index 6187f1c45c00..2fd57a750f94 100644 --- a/doc/html/appdev/refs/api/krb5_kt_read_service_key.html +++ b/doc/html/appdev/refs/api/krb5_kt_read_service_key.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_kt_read_service_key - Retrieve a service key from a key table. — 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_kt_remove_entry - Remove an entry from a key table." href="krb5_kt_remove_entry.html" /> <link rel="prev" title="krb5_kt_next_entry - Retrieve the next entry from the key table." href="krb5_kt_next_entry.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-read-service-key-retrieve-a-service-key-from-a-key-table"> + <section id="krb5-kt-read-service-key-retrieve-a-service-key-from-a-key-table"> <h1>krb5_kt_read_service_key - Retrieve a service key from a key table.<a class="headerlink" href="#krb5-kt-read-service-key-retrieve-a-service-key-from-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_read_service_key"> -<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_kt_read_service_key</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>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> keyprocarg</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> principal</em>, <a class="reference internal" href="../types/krb5_kvno.html#c.krb5_kvno" title="krb5_kvno">krb5_kvno</a><em> vno</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_read_service_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_read_service_key"> +<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_kt_read_service_key</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>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">keyprocarg</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <a class="reference internal" href="../types/krb5_kvno.html#c.krb5_kvno" title="krb5_kvno"><span class="n"><span class="pre">krb5_kvno</span></span></a><span class="w"> </span><span class="n"><span class="pre">vno</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">key</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_read_service_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keyprocarg</strong> - Name of a key table (NULL to use default name)</p> <p><strong>[in]</strong> <strong>principal</strong> - Service principal</p> <p><strong>[in]</strong> <strong>vno</strong> - Key version number (0 for highest available)</p> <p><strong>[in]</strong> <strong>enctype</strong> - Encryption type (0 for any type)</p> -<p class="last"><strong>[out]</strong> <strong>key</strong> - Service key from key table</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>key</strong> - Service key from key table</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error code if not found or keyprocarg is invalid.</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error code if not found or keyprocarg is invalid.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Open and search the specified key table for the entry identified by <em>principal</em> , <em>enctype</em> , and <em>vno</em> . If no key is found, return an error code.</p> <p>The default key table is used, unless <em>keyprocarg</em> is non-null. <em>keyprocarg</em> designates a specific key table.</p> -<p>Use <a class="reference internal" href="krb5_free_keyblock.html#c.krb5_free_keyblock" title="krb5_free_keyblock"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_keyblock()</span></code></a> to free <em>key</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_keyblock() to free <em>key</em> when it is no longer needed.</p> +</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_kt_read_service_key - Retrieve a service key from a key table.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_remove_entry.html b/doc/html/appdev/refs/api/krb5_kt_remove_entry.html index 0ff75a3a9231..2f0ab7feac99 100644 --- a/doc/html/appdev/refs/api/krb5_kt_remove_entry.html +++ b/doc/html/appdev/refs/api/krb5_kt_remove_entry.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_kt_remove_entry - Remove an entry from a key table. — 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_kt_start_seq_get - Start a sequential retrieval of key table entries." href="krb5_kt_start_seq_get.html" /> <link rel="prev" title="krb5_kt_read_service_key - Retrieve a service key from a key table." href="krb5_kt_read_service_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-remove-entry-remove-an-entry-from-a-key-table"> + <section id="krb5-kt-remove-entry-remove-an-entry-from-a-key-table"> <h1>krb5_kt_remove_entry - Remove an entry from a key table.<a class="headerlink" href="#krb5-kt-remove-entry-remove-an-entry-from-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_remove_entry"> -<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_kt_remove_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> id</em>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry">krb5_keytab_entry</a> *<em> entry</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_remove_entry" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_remove_entry"> +<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_kt_remove_entry</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">id</span></span>, <a class="reference internal" href="../types/krb5_keytab_entry.html#c.krb5_keytab_entry" title="krb5_keytab_entry"><span class="n"><span class="pre">krb5_keytab_entry</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">entry</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_remove_entry" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>id</strong> - Key table handle</p> -<p class="last"><strong>[in]</strong> <strong>entry</strong> - Entry to remove from key table</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 simple"> -<li>0 Success</li> -<li>KRB5_KT_NOWRITE Key table is not writable</li> +<p><strong>[in]</strong> <strong>entry</strong> - Entry to remove from key table</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</p></li> +<li><p>KRB5_KT_NOWRITE Key table is not writable</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_kt_remove_entry - Remove an entry from a key table.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_resolve.html b/doc/html/appdev/refs/api/krb5_kt_resolve.html index 3b403d3fb149..a801e5c5239e 100644 --- a/doc/html/appdev/refs/api/krb5_kt_resolve.html +++ b/doc/html/appdev/refs/api/krb5_kt_resolve.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_kt_resolve - Get a handle for a key table. — 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_kuserok - Determine if a principal is authorized to log in as a local user." href="krb5_kuserok.html" /> <link rel="prev" title="krb5_kt_get_type - Return the type of a key table." href="krb5_kt_get_type.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-resolve-get-a-handle-for-a-key-table"> + <section id="krb5-kt-resolve-get-a-handle-for-a-key-table"> <h1>krb5_kt_resolve - Get a handle for a key table.<a class="headerlink" href="#krb5-kt-resolve-get-a-handle-for-a-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_resolve"> -<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_kt_resolve</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 char *<em> name</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a> *<em> ktid</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_resolve" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_resolve"> +<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_kt_resolve</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ktid</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_resolve" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>name</strong> - Name of the key table</p> -<p class="last"><strong>[out]</strong> <strong>ktid</strong> - Key table handle</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>ktid</strong> - Key table handle</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Resolve the key table name <em>name</em> and set <em>ktid</em> to a handle identifying the key table. Use <a class="reference internal" href="krb5_kt_close.html#c.krb5_kt_close" title="krb5_kt_close"><code class="xref c c-func docutils literal"><span class="pre">krb5_kt_close()</span></code></a> to free <em>ktid</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Resolve the key table name <em>name</em> and set <em>ktid</em> to a handle identifying the key table. Use krb5_kt_close() to free <em>ktid</em> when it is no longer needed.</p> <blockquote> -<div><em>name</em> must be of the form <strong>type:residual</strong> , where <em>type</em> must be a type known to the library and <em>residual</em> portion should be specific to the particular keytab type. If no <em>type</em> is given, the default is <strong>FILE</strong> .</div></blockquote> +<div><p><em>name</em> must be of the form <strong>type:residual</strong> , where <em>type</em> must be a type known to the library and <em>residual</em> portion should be specific to the particular keytab type. If no <em>type</em> is given, the default is <strong>FILE</strong> .</p> +</div></blockquote> <p>If <em>name</em> is of type <strong>FILE</strong> , the keytab file is not opened by this call.</p> -</div> +</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_kt_resolve - Get a handle for a key table.</a></li> @@ -150,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kt_start_seq_get.html b/doc/html/appdev/refs/api/krb5_kt_start_seq_get.html index 1a62dbbf1d11..821c872a28b7 100644 --- a/doc/html/appdev/refs/api/krb5_kt_start_seq_get.html +++ b/doc/html/appdev/refs/api/krb5_kt_start_seq_get.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_kt_start_seq_get - Start a sequential retrieval of key table entries. — 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_make_authdata_kdc_issued - Encode and sign AD-KDCIssued authorization data." href="krb5_make_authdata_kdc_issued.html" /> <link rel="prev" title="krb5_kt_remove_entry - Remove an entry from a key table." href="krb5_kt_remove_entry.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kt-start-seq-get-start-a-sequential-retrieval-of-key-table-entries"> + <section id="krb5-kt-start-seq-get-start-a-sequential-retrieval-of-key-table-entries"> <h1>krb5_kt_start_seq_get - Start a sequential retrieval of key table entries.<a class="headerlink" href="#krb5-kt-start-seq-get-start-a-sequential-retrieval-of-key-table-entries" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kt_start_seq_get"> -<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_kt_start_seq_get</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor">krb5_kt_cursor</a> *<em> cursor</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_start_seq_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kt_start_seq_get"> +<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_kt_start_seq_get</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>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_kt_cursor.html#c.krb5_kt_cursor" title="krb5_kt_cursor"><span class="n"><span class="pre">krb5_kt_cursor</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cursor</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kt_start_seq_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>keytab</strong> - Key table handle</p> -<p class="last"><strong>[out]</strong> <strong>cursor</strong> - Cursor</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>cursor</strong> - Cursor</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Prepare to read sequentially every key in the specified key table. Use <a class="reference internal" href="krb5_kt_end_seq_get.html#c.krb5_kt_end_seq_get" title="krb5_kt_end_seq_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_kt_end_seq_get()</span></code></a> to release the cursor when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Prepare to read sequentially every key in the specified key table. Use krb5_kt_end_seq_get() to release the cursor when it is no longer needed.</p> +</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_kt_start_seq_get - Start a sequential retrieval of key table entries.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_kuserok.html b/doc/html/appdev/refs/api/krb5_kuserok.html index 7e4283fc7496..9a87f53c49f0 100644 --- a/doc/html/appdev/refs/api/krb5_kuserok.html +++ b/doc/html/appdev/refs/api/krb5_kuserok.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_kuserok - Determine if a principal is authorized to log in as a local user. — 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_parse_name - Convert a string principal name to a krb5_principal structure." href="krb5_parse_name.html" /> <link rel="prev" title="krb5_kt_resolve - Get a handle for a key table." href="krb5_kt_resolve.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-kuserok-determine-if-a-principal-is-authorized-to-log-in-as-a-local-user"> + <section id="krb5-kuserok-determine-if-a-principal-is-authorized-to-log-in-as-a-local-user"> <h1>krb5_kuserok - Determine if a principal is authorized to log in as a local user.<a class="headerlink" href="#krb5-kuserok-determine-if-a-principal-is-authorized-to-log-in-as-a-local-user" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_kuserok"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_kuserok</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> principal</em>, const char *<em> luser</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kuserok" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_kuserok"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_kuserok</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">luser</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_kuserok" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal name</p> -<p class="last"><strong>[in]</strong> <strong>luser</strong> - Local username</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>TRUE Principal is authorized to log in as user; FALSE otherwise.</li> +<p><strong>[in]</strong> <strong>luser</strong> - Local username</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE Principal is authorized to log in as user; FALSE otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Determine whether <em>principal</em> is authorized to log in as a local user <em>luser</em> .</p> -</div> +</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_kuserok - Determine if a principal is authorized to log in as a local user.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_make_authdata_kdc_issued.html b/doc/html/appdev/refs/api/krb5_make_authdata_kdc_issued.html index 29aaebcc0c90..07f29e546711 100644 --- a/doc/html/appdev/refs/api/krb5_make_authdata_kdc_issued.html +++ b/doc/html/appdev/refs/api/krb5_make_authdata_kdc_issued.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_make_authdata_kdc_issued - Encode and sign AD-KDCIssued authorization data. — 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_marshal_credentials - Serialize a krb5_creds object." href="krb5_marshal_credentials.html" /> <link rel="prev" title="krb5_kt_start_seq_get - Start a sequential retrieval of key table entries." href="krb5_kt_start_seq_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-make-authdata-kdc-issued-encode-and-sign-ad-kdcissued-authorization-data"> + <section id="krb5-make-authdata-kdc-issued-encode-and-sign-ad-kdcissued-authorization-data"> <h1>krb5_make_authdata_kdc_issued - Encode and sign AD-KDCIssued authorization data.<a class="headerlink" href="#krb5-make-authdata-kdc-issued-encode-and-sign-ad-kdcissued-authorization-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_make_authdata_kdc_issued"> -<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_make_authdata_kdc_issued</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_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> issuer</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> authdata</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> ad_kdcissued</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_make_authdata_kdc_issued" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_make_authdata_kdc_issued"> +<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_make_authdata_kdc_issued</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_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">issuer</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authdata</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ad_kdcissued</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_make_authdata_kdc_issued" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Session key</p> <p><strong>[in]</strong> <strong>issuer</strong> - The name of the issuing principal</p> <p><strong>[in]</strong> <strong>authdata</strong> - List of authorization data to be signed</p> -<p class="last"><strong>[out]</strong> <strong>ad_kdcissued</strong> - List containing AD-KDCIssued authdata</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>ad_kdcissued</strong> - List containing AD-KDCIssued authdata</p> +</dd> +</dl> <p>This function wraps a list of authorization data entries <em>authdata</em> in an AD-KDCIssued container (see RFC 4120 section 5.2.6.2) signed with <em>key</em> . The result is returned in <em>ad_kdcissued</em> as a single-element list.</p> -</div> +</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_make_authdata_kdc_issued - Encode and sign AD-KDCIssued authorization data.</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_marshal_credentials.html b/doc/html/appdev/refs/api/krb5_marshal_credentials.html index 987e6958ad6c..e529478d5d14 100644 --- a/doc/html/appdev/refs/api/krb5_marshal_credentials.html +++ b/doc/html/appdev/refs/api/krb5_marshal_credentials.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_marshal_credentials - Serialize a krb5_creds object. — 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_merge_authdata - Merge two authorization data lists into a new list." href="krb5_merge_authdata.html" /> <link rel="prev" title="krb5_make_authdata_kdc_issued - Encode and sign AD-KDCIssued authorization data." href="krb5_make_authdata_kdc_issued.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-marshal-credentials-serialize-a-krb5-creds-object"> + <section id="krb5-marshal-credentials-serialize-a-krb5-creds-object"> <h1>krb5_marshal_credentials - Serialize a krb5_creds object.<a class="headerlink" href="#krb5-marshal-credentials-serialize-a-krb5-creds-object" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_marshal_credentials"> -<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_marshal_credentials</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> **<em> data_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_marshal_credentials" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_marshal_credentials"> +<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_marshal_credentials</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">data_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_marshal_credentials" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>in_creds</strong> - The credentials object to serialize</p> -<p class="last"><strong>[out]</strong> <strong>data_out</strong> - The serialized credentials</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>data_out</strong> - The serialized credentials</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>Serialize <em>creds</em> in the format used by the FILE ccache format (vesion 4) and KCM ccache protocol.</p> -<p>Use <a class="reference internal" href="krb5_free_data.html#c.krb5_free_data" title="krb5_free_data"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_data()</span></code></a> to free <em>data_out</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_data() to free <em>data_out</em> when it is no longer needed.</p> +</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_marshal_credentials - Serialize a krb5_creds object.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_merge_authdata.html b/doc/html/appdev/refs/api/krb5_merge_authdata.html index 1e2990bc8aab..dfc79e02d96f 100644 --- a/doc/html/appdev/refs/api/krb5_merge_authdata.html +++ b/doc/html/appdev/refs/api/krb5_merge_authdata.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_merge_authdata - Merge two authorization data lists into a new list. — 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_mk_1cred - Format a KRB-CRED message for a single set of credentials." href="krb5_mk_1cred.html" /> <link rel="prev" title="krb5_marshal_credentials - Serialize a krb5_creds object." href="krb5_marshal_credentials.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-merge-authdata-merge-two-authorization-data-lists-into-a-new-list"> + <section id="krb5-merge-authdata-merge-two-authorization-data-lists-into-a-new-list"> <h1>krb5_merge_authdata - Merge two authorization data lists into a new list.<a class="headerlink" href="#krb5-merge-authdata-merge-two-authorization-data-lists-into-a-new-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_merge_authdata"> -<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_merge_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> inauthdat1</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *const *<em> inauthdat2</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> outauthdat</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_merge_authdata" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_merge_authdata"> +<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_merge_authdata</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>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">inauthdat1</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">inauthdat2</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">outauthdat</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_merge_authdata" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>inauthdat1</strong> - First list of <em>krb5_authdata</em> structures</p> <p><strong>[in]</strong> <strong>inauthdat2</strong> - Second list of <em>krb5_authdata</em> structures</p> -<p class="last"><strong>[out]</strong> <strong>outauthdat</strong> - Merged list of <em>krb5_authdata</em> structures</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>outauthdat</strong> - Merged list of <em>krb5_authdata</em> structures</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> -<p>Merge two authdata arrays, such as the array from a ticket and authenticator. Use <a class="reference internal" href="krb5_free_authdata.html#c.krb5_free_authdata" title="krb5_free_authdata"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_authdata()</span></code></a> to free <em>outauthdat</em> when it is no longer needed.</p> +</dd> +</dl> +<p>Merge two authdata arrays, such as the array from a ticket and authenticator. Use krb5_free_authdata() to free <em>outauthdat</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The last array entry in <em>inauthdat1</em> and <em>inauthdat2</em> must be a NULL pointer.</p> -</div> +<p class="admonition-title">Note</p> +<p>The last array entry in <em>inauthdat1</em> and <em>inauthdat2</em> must be a NULL pointer.</p> </div> +</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_merge_authdata - Merge two authorization data lists into a new list.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_1cred.html b/doc/html/appdev/refs/api/krb5_mk_1cred.html index 684eb8913bbd..513f13ea5f75 100644 --- a/doc/html/appdev/refs/api/krb5_mk_1cred.html +++ b/doc/html/appdev/refs/api/krb5_mk_1cred.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_mk_1cred - Format a KRB-CRED message for a single set of credentials. — 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_mk_error - Format and encode a KRB_ERROR message." href="krb5_mk_error.html" /> <link rel="prev" title="krb5_merge_authdata - Merge two authorization data lists into a new list." href="krb5_merge_authdata.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-1cred-format-a-krb-cred-message-for-a-single-set-of-credentials"> + <section id="krb5-mk-1cred-format-a-krb-cred-message-for-a-single-set-of-credentials"> <h1>krb5_mk_1cred - Format a KRB-CRED message for a single set of credentials.<a class="headerlink" href="#krb5-mk-1cred-format-a-krb-cred-message-for-a-single-set-of-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_1cred"> -<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_mk_1cred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> **<em> der_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_1cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_1cred"> +<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_mk_1cred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">der_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_1cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>creds</strong> - Pointer to credentials</p> <p><strong>[out]</strong> <strong>der_out</strong> - Encoded credentials</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay cache data (NULL if not needed)</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 simple"> -<li>0 Success</li> -<li>ENOMEM Insufficient memory</li> -<li>KRB5_RC_REQUIRED Message replay detection requires rcache parameter</li> +<p><strong>[out]</strong> <strong>rdata_out</strong> - Replay cache data (NULL if not needed)</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</p></li> +<li><p>ENOMEM Insufficient memory</p></li> +<li><p>KRB5_RC_REQUIRED Message replay detection requires rcache parameter</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This is a convenience function that calls <a class="reference internal" href="krb5_mk_ncred.html#c.krb5_mk_ncred" title="krb5_mk_ncred"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_ncred()</span></code></a> with a single set of credentials.</p> -</div> +</dd> +</dl> +<p>This is a convenience function that calls krb5_mk_ncred() with a single set of credentials.</p> +</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_mk_1cred - Format a KRB-CRED message for a single set of credentials.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_error.html b/doc/html/appdev/refs/api/krb5_mk_error.html index 30018e75b882..19fdbd988858 100644 --- a/doc/html/appdev/refs/api/krb5_mk_error.html +++ b/doc/html/appdev/refs/api/krb5_mk_error.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_mk_error - Format and encode a KRB_ERROR message. — 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_mk_ncred - Format a KRB-CRED message for an array of credentials." href="krb5_mk_ncred.html" /> <link rel="prev" title="krb5_mk_1cred - Format a KRB-CRED message for a single set of credentials." href="krb5_mk_1cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-error-format-and-encode-a-krb-error-message"> + <section id="krb5-mk-error-format-and-encode-a-krb-error-message"> <h1>krb5_mk_error - Format and encode a KRB_ERROR message.<a class="headerlink" href="#krb5-mk-error-format-and-encode-a-krb-error-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_error"> -<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_mk_error</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_error.html#c.krb5_error" title="krb5_error">krb5_error</a> *<em> dec_err</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> enc_err</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_error" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_error"> +<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_mk_error</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_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">dec_err</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">enc_err</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_error" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>dec_err</strong> - Error structure to be encoded</p> -<p class="last"><strong>[out]</strong> <strong>enc_err</strong> - Encoded error structure</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>enc_err</strong> - Encoded error structure</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> -<p>This function creates a <strong>KRB_ERROR</strong> message in <em>enc_err</em> . 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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>enc_err</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function creates a <strong>KRB_ERROR</strong> message in <em>enc_err</em> . Use krb5_free_data_contents() to free <em>enc_err</em> when it is no longer needed.</p> +</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_mk_error - Format and encode a KRB_ERROR message.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_ncred.html b/doc/html/appdev/refs/api/krb5_mk_ncred.html index 971d340fb5c5..85684bb8245d 100644 --- a/doc/html/appdev/refs/api/krb5_mk_ncred.html +++ b/doc/html/appdev/refs/api/krb5_mk_ncred.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_mk_ncred - Format a KRB-CRED message for an array of credentials. — 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_mk_priv - Format a KRB-PRIV message." href="krb5_mk_priv.html" /> <link rel="prev" title="krb5_mk_error - Format and encode a KRB_ERROR message." href="krb5_mk_error.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,62 +52,56 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-ncred-format-a-krb-cred-message-for-an-array-of-credentials"> + <section id="krb5-mk-ncred-format-a-krb-cred-message-for-an-array-of-credentials"> <h1>krb5_mk_ncred - Format a KRB-CRED message for an array of credentials.<a class="headerlink" href="#krb5-mk-ncred-format-a-krb-cred-message-for-an-array-of-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_ncred"> -<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_mk_ncred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> creds</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> **<em> der_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_ncred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_ncred"> +<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_mk_ncred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</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="p"><span class="pre">*</span></span><span class="n"><span class="pre">der_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_ncred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>creds</strong> - Null-terminated array of credentials</p> <p><strong>[out]</strong> <strong>der_out</strong> - Encoded credentials</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay cache information (NULL if not needed)</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 simple"> -<li>0 Success</li> -<li>ENOMEM Insufficient memory</li> -<li>KRB5_RC_REQUIRED Message replay detection requires rcache parameter</li> +<p><strong>[out]</strong> <strong>rdata_out</strong> - Replay cache information (NULL if not needed)</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</p></li> +<li><p>ENOMEM Insufficient memory</p></li> +<li><p>KRB5_RC_REQUIRED Message replay detection requires rcache parameter</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function takes an array of credentials <em>creds</em> and formats a <strong>KRB-CRED</strong> message <em>der_out</em> to pass to <a class="reference internal" href="krb5_rd_cred.html#c.krb5_rd_cred" title="krb5_rd_cred"><code class="xref c c-func docutils literal"><span class="pre">krb5_rd_cred()</span></code></a> .</p> +</dd> +</dl> +<p>This function takes an array of credentials <em>creds</em> and formats a <strong>KRB-CRED</strong> message <em>der_out</em> to pass to krb5_rd_cred().</p> <p>The local and remote addresses in <em>auth_context</em> are optional; if either is specified, they are used to form the sender and receiver addresses in the KRB-CRED message.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> flag is set in <em>auth_context</em> , an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> is not set, no replay cache is used. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></code></a> is set in <em>auth_context</em> , the timestamp used for the KRB-CRED message is stored in <em>rdata_out</em> .</p> -<p>If either <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the <em>auth_context</em> local sequence number is included in the KRB-CRED message and then incremented. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the sequence number used is stored in <em>rdata_out</em> .</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>der_out</em> when it is no longer needed.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in <em>auth_context</em> , an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If #KRB5_AUTH_CONTEXT_DO_TIME is not set, no replay cache is used. If #KRB5_AUTH_CONTEXT_RET_TIME is set in <em>auth_context</em> , the timestamp used for the KRB-CRED message is stored in <em>rdata_out</em> .</p> +<p>If either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the <em>auth_context</em> local sequence number is included in the KRB-CRED message and then incremented. If #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the sequence number used is stored in <em>rdata_out</em> .</p> +<p>Use krb5_free_data_contents() to free <em>der_out</em> when it is no longer needed.</p> <p>The message will be encrypted using the send subkey of <em>auth_context</em> if it is present, or the session key otherwise. If neither key is present, the credentials will not be encrypted, and the message should only be sent over a secure channel. No replay cache entry is used in this case.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .</p> </div> +</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_mk_ncred - Format a KRB-CRED message for an array of credentials.</a></li> @@ -160,6 +145,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -167,8 +153,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_priv.html b/doc/html/appdev/refs/api/krb5_mk_priv.html index c50efee3a4b0..7f4fdddce075 100644 --- a/doc/html/appdev/refs/api/krb5_mk_priv.html +++ b/doc/html/appdev/refs/api/krb5_mk_priv.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_mk_priv - Format a KRB-PRIV message. — 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_mk_rep - Format and encrypt a KRB_AP_REP message." href="krb5_mk_rep.html" /> <link rel="prev" title="krb5_mk_ncred - Format a KRB-CRED message for an array of credentials." href="krb5_mk_ncred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-priv-format-a-krb-priv-message"> + <section id="krb5-mk-priv-format-a-krb-priv-message"> <h1>krb5_mk_priv - Format a KRB-PRIV message.<a class="headerlink" href="#krb5-mk-priv-format-a-krb-priv-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_priv"> -<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_mk_priv</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> userdata</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> der_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_priv" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_priv"> +<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_mk_priv</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">userdata</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">der_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_priv" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>userdata</strong> - User data for <strong>KRB-PRIV</strong> message</p> <p><strong>[out]</strong> <strong>der_out</strong> - Formatted <strong>KRB-PRIV</strong> message</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay data (NULL if not needed)</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>rdata_out</strong> - Replay data (NULL if not needed)</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> -<p>This function is similar to <a class="reference internal" href="krb5_mk_safe.html#c.krb5_mk_safe" title="krb5_mk_safe"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_safe()</span></code></a> , but the message is encrypted and integrity-protected, not just integrity-protected.</p> +</dd> +</dl> +<p>This function is similar to krb5_mk_safe(), but the message is encrypted and integrity-protected, not just integrity-protected.</p> <p>The local address in <em>auth_context</em> must be set, and is used to form the sender address used in the KRB-PRIV message. The remote address is optional; if specified, it will be used to form the receiver address used in the message.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> flag is set in <em>auth_context</em> , a timestamp is included in the KRB-PRIV message, and an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> is not set, no replay cache is used. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></code></a> is set in <em>auth_context</em> , a timestamp is included in the KRB-PRIV message and is stored in <em>rdata_out</em> .</p> -<p>If either <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the <em>auth_context</em> local sequence number is included in the KRB-PRIV message and then incremented. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the sequence number used is stored in <em>rdata_out</em> .</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>der_out</em> when it is no longer needed.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in <em>auth_context</em> , a timestamp is included in the KRB-PRIV message, and an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If #KRB5_AUTH_CONTEXT_DO_TIME is not set, no replay cache is used. If #KRB5_AUTH_CONTEXT_RET_TIME is set in <em>auth_context</em> , a timestamp is included in the KRB-PRIV message and is stored in <em>rdata_out</em> .</p> +<p>If either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the <em>auth_context</em> local sequence number is included in the KRB-PRIV message and then incremented. If #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the sequence number used is stored in <em>rdata_out</em> .</p> +<p>Use krb5_free_data_contents() to free <em>der_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .</p> </div> +</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_mk_priv - Format a KRB-PRIV message.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_rep.html b/doc/html/appdev/refs/api/krb5_mk_rep.html index e0ce4d8093f0..fabc30f8552c 100644 --- a/doc/html/appdev/refs/api/krb5_mk_rep.html +++ b/doc/html/appdev/refs/api/krb5_mk_rep.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_mk_rep - Format and encrypt a KRB_AP_REP message. — 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_mk_rep_dce - Format and encrypt a KRB_AP_REP message for DCE RPC." href="krb5_mk_rep_dce.html" /> <link rel="prev" title="krb5_mk_priv - Format a KRB-PRIV message." href="krb5_mk_priv.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-rep-format-and-encrypt-a-krb-ap-rep-message"> + <section id="krb5-mk-rep-format-and-encrypt-a-krb-ap-rep-message"> <h1>krb5_mk_rep - Format and encrypt a KRB_AP_REP message.<a class="headerlink" href="#krb5-mk-rep-format-and-encrypt-a-krb-ap-rep-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_rep"> -<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_mk_rep</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_rep" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_rep"> +<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_mk_rep</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_rep" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REP</strong> message</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>outbuf</strong> - <strong>AP-REP</strong> message</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 fills in <em>outbuf</em> with an AP-REP message using information from <em>auth_context</em> .</p> -<p>If the flags in <em>auth_context</em> indicate that a sequence number should be used (either <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> ) and the local sequence number in <em>auth_context</em> is 0, a new number will be generated with krb5_generate_seq_number().</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>outbuf</em> when it is no longer needed.</p> -</div> +<p>If the flags in <em>auth_context</em> indicate that a sequence number should be used (either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or #KRB5_AUTH_CONTEXT_RET_SEQUENCE) and the local sequence number in <em>auth_context</em> is 0, a new number will be generated with krb5_generate_seq_number().</p> +<p>Use krb5_free_data_contents() to free <em>outbuf</em> when it is no longer needed.</p> +</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_mk_rep - Format and encrypt a KRB_AP_REP message.</a></li> @@ -144,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_rep_dce.html b/doc/html/appdev/refs/api/krb5_mk_rep_dce.html index c39c9377619c..703716fe2958 100644 --- a/doc/html/appdev/refs/api/krb5_mk_rep_dce.html +++ b/doc/html/appdev/refs/api/krb5_mk_rep_dce.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_mk_rep_dce - Format and encrypt a KRB_AP_REP message for DCE RPC. — 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_mk_req - Create a KRB_AP_REQ message." href="krb5_mk_req.html" /> <link rel="prev" title="krb5_mk_rep - Format and encrypt a KRB_AP_REP message." href="krb5_mk_rep.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-rep-dce-format-and-encrypt-a-krb-ap-rep-message-for-dce-rpc"> + <section id="krb5-mk-rep-dce-format-and-encrypt-a-krb-ap-rep-message-for-dce-rpc"> <h1>krb5_mk_rep_dce - Format and encrypt a KRB_AP_REP message for DCE RPC.<a class="headerlink" href="#krb5-mk-rep-dce-format-and-encrypt-a-krb-ap-rep-message-for-dce-rpc" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_rep_dce"> -<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_mk_rep_dce</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_rep_dce" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_rep_dce"> +<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_mk_rep_dce</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_rep_dce" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> -<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REP</strong> message</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>outbuf</strong> - <strong>AP-REP</strong> message</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> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>outbuf</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_data_contents() to free <em>outbuf</em> when it is no longer needed.</p> +</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_mk_rep_dce - Format and encrypt a KRB_AP_REP message for DCE RPC.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_req.html b/doc/html/appdev/refs/api/krb5_mk_req.html index 8e4a73a4bc6d..dd3ecfd3a32d 100644 --- a/doc/html/appdev/refs/api/krb5_mk_req.html +++ b/doc/html/appdev/refs/api/krb5_mk_req.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_mk_req - Create a KRB_AP_REQ message. — 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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials." href="krb5_mk_req_extended.html" /> <link rel="prev" title="krb5_mk_rep_dce - Format and encrypt a KRB_AP_REP message for DCE RPC." href="krb5_mk_rep_dce.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-req-create-a-krb-ap-req-message"> + <section id="krb5-mk-req-create-a-krb-ap-req-message"> <h1>krb5_mk_req - Create a KRB_AP_REQ message.<a class="headerlink" href="#krb5-mk-req-create-a-krb-ap-req-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_req"> -<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_mk_req</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> ap_req_options</em>, const char *<em> service</em>, const char *<em> hostname</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in_data</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_req"> +<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_mk_req</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">ap_req_options</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">service</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">hostname</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">in_data</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</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">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> -<p><strong>[in]</strong> <strong>ap_req_options</strong> - <code class="xref py py-data docutils literal"><span class="pre">AP_OPTS</span></code> options</p> +<p><strong>[in]</strong> <strong>ap_req_options</strong> - Options (see AP_OPTS macros)</p> <p><strong>[in]</strong> <strong>service</strong> - Service name, or NULL to use <strong>“host”</strong></p> <p><strong>[in]</strong> <strong>hostname</strong> - Host name, or NULL to use local hostname</p> <p><strong>[in]</strong> <strong>in_data</strong> - Application data to be checksummed in the authenticator, or NULL</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache used to obtain credentials for the desired service.</p> -<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REQ</strong> message</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>outbuf</strong> - <strong>AP-REQ</strong> message</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> -<p>This function is similar to <a class="reference internal" href="krb5_mk_req_extended.html#c.krb5_mk_req_extended" title="krb5_mk_req_extended"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_req_extended()</span></code></a> except that it uses a given <em>hostname</em> , <em>service</em> , and <em>ccache</em> to construct a service principal name and obtain credentials.</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>outbuf</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function is similar to krb5_mk_req_extended() except that it uses a given <em>hostname</em> , <em>service</em> , and <em>ccache</em> to construct a service principal name and obtain credentials.</p> +<p>Use krb5_free_data_contents() to free <em>outbuf</em> when it is no longer needed.</p> +</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_mk_req - Create a KRB_AP_REQ message.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_req_extended.html b/doc/html/appdev/refs/api/krb5_mk_req_extended.html index 8add87bae307..8378d044fe7b 100644 --- a/doc/html/appdev/refs/api/krb5_mk_req_extended.html +++ b/doc/html/appdev/refs/api/krb5_mk_req_extended.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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials. — 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_mk_safe - Format a KRB-SAFE message." href="krb5_mk_safe.html" /> <link rel="prev" title="krb5_mk_req - Create a KRB_AP_REQ message." href="krb5_mk_req.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,62 +52,56 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials"> + <section id="krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials"> <h1>krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.<a class="headerlink" href="#krb5-mk-req-extended-create-a-krb-ap-req-message-using-supplied-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_req_extended"> -<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_mk_req_extended</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> ap_req_options</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in_data</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> outbuf</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req_extended" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_req_extended"> +<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_mk_req_extended</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">ap_req_options</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">in_data</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</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">outbuf</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_req_extended" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> -<p><strong>[in]</strong> <strong>ap_req_options</strong> - <code class="xref py py-data docutils literal"><span class="pre">AP_OPTS</span></code> options</p> +<p><strong>[in]</strong> <strong>ap_req_options</strong> - Options (see AP_OPTS macros)</p> <p><strong>[in]</strong> <strong>in_data</strong> - Application data to be checksummed in the authenticator, or NULL</p> <p><strong>[in]</strong> <strong>in_creds</strong> - Credentials for the service with valid ticket and key</p> -<p class="last"><strong>[out]</strong> <strong>outbuf</strong> - <strong>AP-REQ</strong> message</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>outbuf</strong> - <strong>AP-REQ</strong> message</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>Valid <em>ap_req_options</em> are:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/AP_OPTS_USE_SESSION_KEY.html#AP_OPTS_USE_SESSION_KEY" title="AP_OPTS_USE_SESSION_KEY"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SESSION_KEY</span></code></a> - Use the session key when creating the request used for user to user authentication.</li> -<li><a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></code></a> - Request a mutual authentication packet from the receiver.</li> -<li><a class="reference internal" href="../macros/AP_OPTS_USE_SUBKEY.html#AP_OPTS_USE_SUBKEY" title="AP_OPTS_USE_SUBKEY"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_USE_SUBKEY</span></code></a> - Generate a subsession key from the current session key obtained from the credentials.</li> +<li><p>#AP_OPTS_USE_SESSION_KEY - Use the session key when creating the request used for user to user authentication.</p></li> +<li><p>#AP_OPTS_MUTUAL_REQUIRED - Request a mutual authentication packet from the receiver.</p></li> +<li><p>#AP_OPTS_USE_SUBKEY - Generate a subsession key from the current session key obtained from the credentials.</p></li> </ul> </div></blockquote> -<p>This function creates a KRB_AP_REQ message using supplied credentials <em>in_creds</em> . <em>auth_context</em> may point to an existing auth context or to NULL, in which case a new one will be created. If <em>in_data</em> is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. 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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>outbuf</em> when it is no longer needed.</p> +<p>This function creates a KRB_AP_REQ message using supplied credentials <em>in_creds</em> . <em>auth_context</em> may point to an existing auth context or to NULL, in which case a new one will be created. If <em>in_data</em> is non-null, a checksum of it will be included in the authenticator contained in the KRB_AP_REQ message. Use krb5_free_data_contents() to free <em>outbuf</em> when it is no longer needed.</p> </div></blockquote> <p>On successful return, the authenticator is stored in <em>auth_context</em> with the <em>client</em> and <em>checksum</em> fields nulled out. (This is to prevent pointer-sharing problems; the caller should not need these fields anyway, since the caller supplied them.)</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_mk_req.html#c.krb5_mk_req" title="krb5_mk_req"><code class="xref c c-func docutils literal"><span class="pre">krb5_mk_req()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_mk_req()</p> </div> +</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_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials.</a></li> @@ -160,6 +145,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -167,8 +153,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_mk_safe.html b/doc/html/appdev/refs/api/krb5_mk_safe.html index 43a7b31f6527..c1125e048d8e 100644 --- a/doc/html/appdev/refs/api/krb5_mk_safe.html +++ b/doc/html/appdev/refs/api/krb5_mk_safe.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_mk_safe - Format a KRB-SAFE message. — 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_os_localaddr - Return all interface addresses for this host." href="krb5_os_localaddr.html" /> <link rel="prev" title="krb5_mk_req_extended - Create a KRB_AP_REQ message using supplied credentials." href="krb5_mk_req_extended.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,55 +52,49 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-mk-safe-format-a-krb-safe-message"> + <section id="krb5-mk-safe-format-a-krb-safe-message"> <h1>krb5_mk_safe - Format a KRB-SAFE message.<a class="headerlink" href="#krb5-mk-safe-format-a-krb-safe-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_mk_safe"> -<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_mk_safe</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> userdata</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> der_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_safe" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_mk_safe"> +<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_mk_safe</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">userdata</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">der_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_mk_safe" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>userdata</strong> - User data in the message</p> <p><strong>[out]</strong> <strong>der_out</strong> - Formatted <strong>KRB-SAFE</strong> buffer</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay data. Specify NULL if not needed</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>rdata_out</strong> - Replay data. Specify NULL if not needed</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 creates an integrity protected <strong>KRB-SAFE</strong> message using data supplied by the application.</p> -<p>Fields in <em>auth_context</em> specify the checksum type, the keyblock that can be used to seed the checksum, full addresses (host and port) for the sender and receiver, and <code class="xref py py-data docutils literal"><span class="pre">KRB5_AUTH_CONTEXT</span></code> flags.</p> +<p>Fields in <em>auth_context</em> specify the checksum type, the keyblock that can be used to seed the checksum, full addresses (host and port) for the sender and receiver, and KRB5_AUTH_CONTEXT flags.</p> <p>The local address in <em>auth_context</em> must be set, and is used to form the sender address used in the KRB-SAFE message. The remote address is optional; if specified, it will be used to form the receiver address used in the message.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> flag is set in <em>auth_context</em> , a timestamp is included in the KRB-SAFE message, and an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> is not set, no replay cache is used. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></code></a> is set in <em>auth_context</em> , a timestamp is included in the KRB-SAFE message and is stored in <em>rdata_out</em> .</p> -<p>If either <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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the <em>auth_context</em> local sequence number is included in the KRB-SAFE message and then incremented. If <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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> is set, the sequence number used is stored in <em>rdata_out</em> .</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>der_out</em> when it is no longer needed.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in <em>auth_context</em> , a timestamp is included in the KRB-SAFE message, and an entry for the message is entered in an in-memory replay cache to detect if the message is reflected by an attacker. If #KRB5_AUTH_CONTEXT_DO_TIME is not set, no replay cache is used. If #KRB5_AUTH_CONTEXT_RET_TIME is set in <em>auth_context</em> , a timestamp is included in the KRB-SAFE message and is stored in <em>rdata_out</em> .</p> +<p>If either #KRB5_AUTH_CONTEXT_DO_SEQUENCE or #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the <em>auth_context</em> local sequence number is included in the KRB-SAFE message and then incremented. If #KRB5_AUTH_CONTEXT_RET_SEQUENCE is set, the sequence number used is stored in <em>rdata_out</em> .</p> +<p>Use krb5_free_data_contents() to free <em>der_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .</p> </div> +</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_mk_safe - Format a KRB-SAFE message.</a></li> @@ -153,6 +138,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -160,8 +146,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_os_localaddr.html b/doc/html/appdev/refs/api/krb5_os_localaddr.html index 2dd7d370f70d..732658cb135b 100644 --- a/doc/html/appdev/refs/api/krb5_os_localaddr.html +++ b/doc/html/appdev/refs/api/krb5_os_localaddr.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_os_localaddr - Return all interface addresses for this host. — 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_pac_add_buffer - Add a buffer to a PAC handle." href="krb5_pac_add_buffer.html" /> <link rel="prev" title="krb5_mk_safe - Format a KRB-SAFE message." href="krb5_mk_safe.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-os-localaddr-return-all-interface-addresses-for-this-host"> + <section id="krb5-os-localaddr-return-all-interface-addresses-for-this-host"> <h1>krb5_os_localaddr - Return all interface addresses for this host.<a class="headerlink" href="#krb5-os-localaddr-return-all-interface-addresses-for-this-host" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_os_localaddr"> -<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_os_localaddr</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address">krb5_address</a> ***<em> addr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_os_localaddr" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_os_localaddr"> +<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_os_localaddr</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>, <a class="reference internal" href="../types/krb5_address.html#c.krb5_address" title="krb5_address"><span class="n"><span class="pre">krb5_address</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">addr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_os_localaddr" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>addr</strong> - Array of krb5_address pointers, ending with NULL</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> +<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>[out]</strong> <strong>addr</strong> - Array of krb5_address pointers, ending with NULL</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> -<p>Use <a class="reference internal" href="krb5_free_addresses.html#c.krb5_free_addresses" title="krb5_free_addresses"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_addresses()</span></code></a> to free <em>addr</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_addresses() to free <em>addr</em> when it is no longer needed.</p> +</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_os_localaddr - Return all interface addresses for this host.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_add_buffer.html b/doc/html/appdev/refs/api/krb5_pac_add_buffer.html index 1b06c083601b..cfeb870df3a4 100644 --- a/doc/html/appdev/refs/api/krb5_pac_add_buffer.html +++ b/doc/html/appdev/refs/api/krb5_pac_add_buffer.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_pac_add_buffer - Add a buffer to a PAC handle. — 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_pac_free - Free a PAC handle." href="krb5_pac_free.html" /> <link rel="prev" title="krb5_os_localaddr - Return all interface addresses for this host." href="krb5_os_localaddr.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,57 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-add-buffer-add-a-buffer-to-a-pac-handle"> + <section id="krb5-pac-add-buffer-add-a-buffer-to-a-pac-handle"> <h1>krb5_pac_add_buffer - Add a buffer to a PAC handle.<a class="headerlink" href="#krb5-pac-add-buffer-add-a-buffer-to-a-pac-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_add_buffer"> -<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_pac_add_buffer</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4">krb5_ui_4</a><em> type</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_add_buffer" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_add_buffer"> +<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_pac_add_buffer</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4"><span class="n"><span class="pre">krb5_ui_4</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_add_buffer" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[in]</strong> <strong>type</strong> - Buffer type</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - contents</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>data</strong> - contents</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 adds a buffer of type <em>type</em> and contents <em>data</em> to <em>pac</em> if there isn’t already a buffer of this type present.</p> <p>The valid values of <em>type</em> is one of the following:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_PAC_LOGON_INFO.html#KRB5_PAC_LOGON_INFO" title="KRB5_PAC_LOGON_INFO"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_LOGON_INFO</span></code></a> - Logon information</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_CREDENTIALS_INFO.html#KRB5_PAC_CREDENTIALS_INFO" title="KRB5_PAC_CREDENTIALS_INFO"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_CREDENTIALS_INFO</span></code></a> - Credentials information</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_SERVER_CHECKSUM.html#KRB5_PAC_SERVER_CHECKSUM" title="KRB5_PAC_SERVER_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_SERVER_CHECKSUM</span></code></a> - Server checksum</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_PRIVSVR_CHECKSUM.html#KRB5_PAC_PRIVSVR_CHECKSUM" title="KRB5_PAC_PRIVSVR_CHECKSUM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_PRIVSVR_CHECKSUM</span></code></a> - KDC checksum</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_CLIENT_INFO.html#KRB5_PAC_CLIENT_INFO" title="KRB5_PAC_CLIENT_INFO"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_CLIENT_INFO</span></code></a> - Client name and ticket information</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_DELEGATION_INFO.html#KRB5_PAC_DELEGATION_INFO" title="KRB5_PAC_DELEGATION_INFO"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_DELEGATION_INFO</span></code></a> - Constrained delegation information</li> -<li><a class="reference internal" href="../macros/KRB5_PAC_UPN_DNS_INFO.html#KRB5_PAC_UPN_DNS_INFO" title="KRB5_PAC_UPN_DNS_INFO"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PAC_UPN_DNS_INFO</span></code></a> - User principal name and DNS information</li> +<li><p>#KRB5_PAC_LOGON_INFO - Logon information</p></li> +<li><p>#KRB5_PAC_CREDENTIALS_INFO - Credentials information</p></li> +<li><p>#KRB5_PAC_SERVER_CHECKSUM - Server checksum</p></li> +<li><p>#KRB5_PAC_PRIVSVR_CHECKSUM - KDC checksum</p></li> +<li><p>#KRB5_PAC_CLIENT_INFO - Client name and ticket information</p></li> +<li><p>#KRB5_PAC_DELEGATION_INFO - Constrained delegation information</p></li> +<li><p>#KRB5_PAC_UPN_DNS_INFO - User principal name and DNS information</p></li> </ul> </div></blockquote> -</div> +</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_pac_add_buffer - Add a buffer to a PAC handle.</a></li> @@ -155,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -162,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_free.html b/doc/html/appdev/refs/api/krb5_pac_free.html index 38d99c016d84..282b4fff0697 100644 --- a/doc/html/appdev/refs/api/krb5_pac_free.html +++ b/doc/html/appdev/refs/api/krb5_pac_free.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_pac_free - Free a PAC handle. — 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_pac_get_buffer - Retrieve a buffer value from a PAC." href="krb5_pac_get_buffer.html" /> <link rel="prev" title="krb5_pac_add_buffer - Add a buffer to a PAC handle." href="krb5_pac_add_buffer.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-free-free-a-pac-handle"> + <section id="krb5-pac-free-free-a-pac-handle"> <h1>krb5_pac_free - Free a PAC handle.<a class="headerlink" href="#krb5-pac-free-free-a-pac-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_free"> -void <code class="descname">krb5_pac_free</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_pac_free</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>pac</strong> - PAC to be freed</p> -</td> -</tr> -</tbody> -</table> +<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>pac</strong> - PAC to be freed</p> +</dd> +</dl> <p>This function frees the contents of <em>pac</em> and the structure itself.</p> -</div> +</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_pac_free - Free a PAC handle.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_pac_free</code><span class="sig-paren">(</span> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_pac_free</code><span class="sig-paren">(</span> <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_get_buffer.html b/doc/html/appdev/refs/api/krb5_pac_get_buffer.html index 5ad28a51f2a5..1b18f026089c 100644 --- a/doc/html/appdev/refs/api/krb5_pac_get_buffer.html +++ b/doc/html/appdev/refs/api/krb5_pac_get_buffer.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_pac_get_buffer - Retrieve a buffer value from a PAC. — 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_pac_get_types - Return an array of buffer types in a PAC handle." href="krb5_pac_get_types.html" /> <link rel="prev" title="krb5_pac_free - Free a PAC handle." href="krb5_pac_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-get-buffer-retrieve-a-buffer-value-from-a-pac"> + <section id="krb5-pac-get-buffer-retrieve-a-buffer-value-from-a-pac"> <h1>krb5_pac_get_buffer - Retrieve a buffer value from a PAC.<a class="headerlink" href="#krb5-pac-get-buffer-retrieve-a-buffer-value-from-a-pac" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_get_buffer"> -<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_pac_get_buffer</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4">krb5_ui_4</a><em> type</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_buffer" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_get_buffer"> +<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_pac_get_buffer</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4"><span class="n"><span class="pre">krb5_ui_4</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_buffer" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[in]</strong> <strong>type</strong> - Type of buffer to retrieve</p> -<p class="last"><strong>[out]</strong> <strong>data</strong> - Buffer value</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>data</strong> - Buffer value</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> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>data</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_free_data_contents() to free <em>data</em> when it is no longer needed.</p> +</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_pac_get_buffer - Retrieve a buffer value from a PAC.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_get_client_info.html b/doc/html/appdev/refs/api/krb5_pac_get_client_info.html index d4780f73e8e6..73ea56b10167 100644 --- a/doc/html/appdev/refs/api/krb5_pac_get_client_info.html +++ b/doc/html/appdev/refs/api/krb5_pac_get_client_info.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_pac_get_client_info - Read client information from a PAC. — 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_prepend_error_message - Add a prefix to the message for an error code." href="krb5_prepend_error_message.html" /> <link rel="prev" title="krb5_pac_verify_ext - Verify a PAC, possibly from a specified realm." href="krb5_pac_verify_ext.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-get-client-info-read-client-information-from-a-pac"> + <section id="krb5-pac-get-client-info-read-client-information-from-a-pac"> <h1>krb5_pac_get_client_info - Read client information from a PAC.<a class="headerlink" href="#krb5-pac-get-client-info-read-client-information-from-a-pac" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_get_client_info"> -<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_pac_get_client_info</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_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a> *<em> authtime_out</em>, char **<em> princname_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_client_info" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_get_client_info"> +<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_pac_get_client_info</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_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authtime_out</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">princname_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_client_info" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[out]</strong> <strong>authtime_out</strong> - Authentication timestamp (NULL if not needed)</p> -<p class="last"><strong>[out]</strong> <strong>princname_out</strong> - Client account name</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 on success, ENOENT if no PAC_CLIENT_INFO buffer is present in pac , ERANGE if the buffer contains invalid lengths.</li> +<p><strong>[out]</strong> <strong>princname_out</strong> - Client account name</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>0 on success, ENOENT if no PAC_CLIENT_INFO buffer is present in pac , ERANGE if the buffer contains invalid lengths.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Read the PAC_CLIENT_INFO buffer in <em>pac</em> . Place the client account name as a string in <em>princname_out</em> . If <em>authtime_out</em> is not NULL, place the initial authentication timestamp in <em>authtime_out</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.18</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.18</p> </div> +</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_pac_get_client_info - Read client information from a PAC.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_get_types.html b/doc/html/appdev/refs/api/krb5_pac_get_types.html index 23120bd8f7d9..49061b7e3f28 100644 --- a/doc/html/appdev/refs/api/krb5_pac_get_types.html +++ b/doc/html/appdev/refs/api/krb5_pac_get_types.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_pac_get_types - Return an array of buffer types in a PAC handle. — 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_pac_init - Create an empty Privilege Attribute Certificate (PAC) handle." href="krb5_pac_init.html" /> <link rel="prev" title="krb5_pac_get_buffer - Retrieve a buffer value from a PAC." href="krb5_pac_get_buffer.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-get-types-return-an-array-of-buffer-types-in-a-pac-handle"> + <section id="krb5-pac-get-types-return-an-array-of-buffer-types-in-a-pac-handle"> <h1>krb5_pac_get_types - Return an array of buffer types in a PAC handle.<a class="headerlink" href="#krb5-pac-get-types-return-an-array-of-buffer-types-in-a-pac-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_get_types"> -<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_pac_get_types</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, size_t *<em> len</em>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4">krb5_ui_4</a> **<em> types</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_types" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_get_types"> +<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_pac_get_types</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">len</span></span>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4"><span class="n"><span class="pre">krb5_ui_4</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">types</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_get_types" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[out]</strong> <strong>len</strong> - Number of entries in <em>types</em></p> -<p class="last"><strong>[out]</strong> <strong>types</strong> - Array of buffer types</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>types</strong> - Array of buffer types</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> -</div> +</dd> +</dl> +</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_pac_get_types - Return an array of buffer types in a PAC handle.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_init.html b/doc/html/appdev/refs/api/krb5_pac_init.html index 88b59f117f1c..d54e2f053b7d 100644 --- a/doc/html/appdev/refs/api/krb5_pac_init.html +++ b/doc/html/appdev/refs/api/krb5_pac_init.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_pac_init - Create an empty Privilege Attribute Certificate (PAC) handle. — 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_pac_parse - Unparse an encoded PAC into a new handle." href="krb5_pac_parse.html" /> <link rel="prev" title="krb5_pac_get_types - Return an array of buffer types in a PAC handle." href="krb5_pac_get_types.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-init-create-an-empty-privilege-attribute-certificate-pac-handle"> + <section id="krb5-pac-init-create-an-empty-privilege-attribute-certificate-pac-handle"> <h1>krb5_pac_init - Create an empty Privilege Attribute Certificate (PAC) handle.<a class="headerlink" href="#krb5-pac-init-create-an-empty-privilege-attribute-certificate-pac-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_init"> -<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_pac_init</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a> *<em> pac</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_init"> +<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_pac_init</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pac</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>pac</strong> - New PAC handle</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> +<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>[out]</strong> <strong>pac</strong> - New PAC handle</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> -<p>Use <a class="reference internal" href="krb5_pac_free.html#c.krb5_pac_free" title="krb5_pac_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_pac_free()</span></code></a> to free <em>pac</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_pac_free() to free <em>pac</em> when it is no longer needed.</p> +</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_pac_init - Create an empty Privilege Attribute Certificate (PAC) handle.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_parse.html b/doc/html/appdev/refs/api/krb5_pac_parse.html index 959f4011653f..99fd68ad3105 100644 --- a/doc/html/appdev/refs/api/krb5_pac_parse.html +++ b/doc/html/appdev/refs/api/krb5_pac_parse.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_pac_parse - Unparse an encoded PAC into a new handle. — 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_pac_sign" href="krb5_pac_sign.html" /> <link rel="prev" title="krb5_pac_init - Create an empty Privilege Attribute Certificate (PAC) handle." href="krb5_pac_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-parse-unparse-an-encoded-pac-into-a-new-handle"> + <section id="krb5-pac-parse-unparse-an-encoded-pac-into-a-new-handle"> <h1>krb5_pac_parse - Unparse an encoded PAC into a new handle.<a class="headerlink" href="#krb5-pac-parse-unparse-an-encoded-pac-into-a-new-handle" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_parse"> -<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_pac_parse</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 void *<em> ptr</em>, size_t<em> len</em>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a> *<em> pac</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_parse" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_parse"> +<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_pac_parse</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><span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ptr</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">len</span></span>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pac</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_parse" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ptr</strong> - PAC buffer</p> <p><strong>[in]</strong> <strong>len</strong> - Length of <em>ptr</em></p> -<p class="last"><strong>[out]</strong> <strong>pac</strong> - PAC handle</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>pac</strong> - PAC handle</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> -<p>Use <a class="reference internal" href="krb5_pac_free.html#c.krb5_pac_free" title="krb5_pac_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_pac_free()</span></code></a> to free <em>pac</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>Use krb5_pac_free() to free <em>pac</em> when it is no longer needed.</p> +</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_pac_parse - Unparse an encoded PAC into a new handle.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_sign.html b/doc/html/appdev/refs/api/krb5_pac_sign.html index 824aa98bdbd4..3339fd132f83 100644 --- a/doc/html/appdev/refs/api/krb5_pac_sign.html +++ b/doc/html/appdev/refs/api/krb5_pac_sign.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_pac_sign — 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_pac_sign_ext" href="krb5_pac_sign_ext.html" /> <link rel="prev" title="krb5_pac_parse - Unparse an encoded PAC into a new handle." href="krb5_pac_parse.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-sign"> + <section id="krb5-pac-sign"> <h1>krb5_pac_sign<a class="headerlink" href="#krb5-pac-sign" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_sign"> -<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_pac_sign</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> authtime</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server_key</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr_key</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_sign" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_sign"> +<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_pac_sign</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">authtime</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</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">server_key</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">privsvr_key</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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_sign" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>pac</strong></p> <p><strong>authtime</strong></p> <p><strong>principal</strong></p> <p><strong>server_key</strong></p> <p><strong>privsvr_key</strong></p> -<p class="last"><strong>data</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>data</strong></p> +</dd> +</dl> <p>DEPRECATED Use krb5_kdc_sign_ticket() instead.</p> -</div> +</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_pac_sign</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_sign_ext.html b/doc/html/appdev/refs/api/krb5_pac_sign_ext.html index 161cede62ccf..c09f4cfbe790 100644 --- a/doc/html/appdev/refs/api/krb5_pac_sign_ext.html +++ b/doc/html/appdev/refs/api/krb5_pac_sign_ext.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_pac_sign_ext — 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_pac_verify - Verify a PAC." href="krb5_pac_verify.html" /> <link rel="prev" title="krb5_pac_sign" href="krb5_pac_sign.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,38 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-sign-ext"> + <section id="krb5-pac-sign-ext"> <h1>krb5_pac_sign_ext<a class="headerlink" href="#krb5-pac-sign-ext" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_sign_ext"> -<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_pac_sign_ext</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> authtime</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server_key</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr_key</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> with_realm</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_sign_ext" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_sign_ext"> +<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_pac_sign_ext</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>, <a class="reference internal" href="../types/krb5_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">authtime</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</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">server_key</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">privsvr_key</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">with_realm</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">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_sign_ext" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>pac</strong></p> <p><strong>authtime</strong></p> <p><strong>principal</strong></p> <p><strong>server_key</strong></p> <p><strong>privsvr_key</strong></p> <p><strong>with_realm</strong></p> -<p class="last"><strong>data</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>data</strong></p> +</dd> +</dl> <p>DEPRECATED Use krb5_kdc_sign_ticket() instead.</p> -</div> +</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_pac_sign_ext</a></li> @@ -136,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_verify.html b/doc/html/appdev/refs/api/krb5_pac_verify.html index e62b8ad34e1c..97c18d6125c6 100644 --- a/doc/html/appdev/refs/api/krb5_pac_verify.html +++ b/doc/html/appdev/refs/api/krb5_pac_verify.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_pac_verify - Verify a PAC. — 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_pac_verify_ext - Verify a PAC, possibly from a specified realm." href="krb5_pac_verify_ext.html" /> <link rel="prev" title="krb5_pac_sign_ext" href="krb5_pac_sign_ext.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-verify-verify-a-pac"> + <section id="krb5-pac-verify-verify-a-pac"> <h1>krb5_pac_verify - Verify a PAC.<a class="headerlink" href="#krb5-pac-verify-verify-a-pac" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_verify"> -<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_pac_verify</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_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> authtime</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_verify" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_verify"> +<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_pac_verify</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_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">authtime</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</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">server</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">privsvr</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_verify" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[in]</strong> <strong>authtime</strong> - Expected timestamp</p> <p><strong>[in]</strong> <strong>principal</strong> - Expected principal name (or NULL)</p> <p><strong>[in]</strong> <strong>server</strong> - Key to validate server checksum (or NULL)</p> -<p class="last"><strong>[in]</strong> <strong>privsvr</strong> - Key to validate KDC checksum (or NULL)</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>privsvr</strong> - Key to validate KDC checksum (or NULL)</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 validates <em>pac</em> against the supplied <em>server</em> , <em>privsvr</em> , <em>principal</em> and <em>authtime</em> . If <em>principal</em> is NULL, the principal and authtime are not verified. If <em>server</em> or <em>privsvr</em> is NULL, the corresponding checksum is not verified.</p> <p>If successful, <em>pac</em> is marked as verified.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">A checksum mismatch can occur if the PAC was copied from a cross-realm TGT by an ignorant KDC; also macOS Server Open Directory (as of 10.6) generates PACs with no server checksum at all. One should consider not failing the whole authentication because of this reason, but, instead, treating the ticket as if it did not contain a PAC or marking the PAC information as non-verified.</p> -</div> +<p class="admonition-title">Note</p> +<p>A checksum mismatch can occur if the PAC was copied from a cross-realm TGT by an ignorant KDC; also macOS Server Open Directory (as of 10.6) generates PACs with no server checksum at all. One should consider not failing the whole authentication because of this reason, but, instead, treating the ticket as if it did not contain a PAC or marking the PAC information as non-verified.</p> </div> +</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_pac_verify - Verify a PAC.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_pac_verify_ext.html b/doc/html/appdev/refs/api/krb5_pac_verify_ext.html index edcc5ada342c..13fa7f5bb992 100644 --- a/doc/html/appdev/refs/api/krb5_pac_verify_ext.html +++ b/doc/html/appdev/refs/api/krb5_pac_verify_ext.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_pac_verify_ext - Verify a PAC, possibly from a specified realm. — 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_pac_get_client_info - Read client information from a PAC." href="krb5_pac_get_client_info.html" /> <link rel="prev" title="krb5_pac_verify - Verify a PAC." href="krb5_pac_verify.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,41 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-pac-verify-ext-verify-a-pac-possibly-from-a-specified-realm"> + <section id="krb5-pac-verify-ext-verify-a-pac-possibly-from-a-specified-realm"> <h1>krb5_pac_verify_ext - Verify a PAC, possibly from a specified realm.<a class="headerlink" href="#krb5-pac-verify-ext-verify-a-pac-possibly-from-a-specified-realm" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_pac_verify_ext"> -<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_pac_verify_ext</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_pac.html#c.krb5_pac" title="krb5_pac">krb5_pac</a><em> pac</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> authtime</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> server</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> privsvr</em>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a><em> with_realm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_verify_ext" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_pac_verify_ext"> +<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_pac_verify_ext</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_pac.html#c.krb5_pac" title="krb5_pac"><span class="n"><span class="pre">krb5_pac</span></span></a><span class="w"> </span><span class="n"><span class="pre">pac</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">authtime</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</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">server</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">privsvr</span></span>, <a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="n"><span class="pre">with_realm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_pac_verify_ext" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pac</strong> - PAC handle</p> <p><strong>[in]</strong> <strong>authtime</strong> - Expected timestamp</p> <p><strong>[in]</strong> <strong>principal</strong> - Expected principal name (or NULL)</p> <p><strong>[in]</strong> <strong>server</strong> - Key to validate server checksum (or NULL)</p> <p><strong>[in]</strong> <strong>privsvr</strong> - Key to validate KDC checksum (or NULL)</p> -<p class="last"><strong>[in]</strong> <strong>with_realm</strong> - If true, expect the realm of <em>principal</em></p> -</td> -</tr> -</tbody> -</table> -<p>This function is similar to <a class="reference internal" href="krb5_pac_verify.html#c.krb5_pac_verify" title="krb5_pac_verify"><code class="xref c c-func docutils literal"><span class="pre">krb5_pac_verify()</span></code></a> , but adds a parameter <em>with_realm</em> . If <em>with_realm</em> is true, the PAC_CLIENT_INFO field is expected to include the realm of <em>principal</em> as well as the name. This flag is necessary to verify PACs in cross-realm S4U2Self referral TGTs.</p> +<p><strong>[in]</strong> <strong>with_realm</strong> - If true, expect the realm of <em>principal</em></p> +</dd> +</dl> +<p>This function is similar to krb5_pac_verify(), but adds a parameter <em>with_realm</em> . If <em>with_realm</em> is true, the PAC_CLIENT_INFO field is expected to include the realm of <em>principal</em> as well as the name. This flag is necessary to verify PACs in cross-realm S4U2Self referral TGTs.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.17</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.17</p> </div> +</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_pac_verify_ext - Verify a PAC, possibly from a specified realm.</a></li> @@ -139,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -146,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_parse_name.html b/doc/html/appdev/refs/api/krb5_parse_name.html index 32865fe8204c..09e3ab99c8a0 100644 --- a/doc/html/appdev/refs/api/krb5_parse_name.html +++ b/doc/html/appdev/refs/api/krb5_parse_name.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_parse_name - Convert a string principal name to a krb5_principal structure. — 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_parse_name_flags - Convert a string principal name to a krb5_principal with flags." href="krb5_parse_name_flags.html" /> <link rel="prev" title="krb5_kuserok - Determine if a principal is authorized to log in as a local user." href="krb5_kuserok.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,57 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-parse-name-convert-a-string-principal-name-to-a-krb5-principal-structure"> + <section id="krb5-parse-name-convert-a-string-principal-name-to-a-krb5-principal-structure"> <h1>krb5_parse_name - Convert a string principal name to a krb5_principal structure.<a class="headerlink" href="#krb5-parse-name-convert-a-string-principal-name-to-a-krb5-principal-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_parse_name"> -<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_parse_name</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 char *<em> name</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> principal_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_parse_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_parse_name"> +<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_parse_name</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">principal_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_parse_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>name</strong> - String representation of a principal name</p> -<p class="last"><strong>[out]</strong> <strong>principal_out</strong> - New principal</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>principal_out</strong> - New principal</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Convert a string representation of a principal name to a krb5_principal structure.</p> <p>A string representation of a Kerberos name consists of one or more principal name components, separated by slashes, optionally followed by the @ character and a realm name. If the realm name is not specified, the local realm is used.</p> <p>To use the slash and @ symbols as part of a component (quoted) instead of using them as a component separator or as a realm prefix), put a backslash () character in front of the symbol. Similarly, newline, tab, backspace, and NULL characters can be included in a component by using <strong>n</strong> , <strong>t</strong> , <strong>b</strong> or <strong>0</strong> , respectively.</p> <p>Beginning with release 1.20, the name type of the principal will be inferred as <strong>KRB5_NT_SRV_INST</strong> or <strong>KRB5_NT_WELLKNOWN</strong> based on the principal name. The type will be <strong>KRB5_NT_PRINCIPAL</strong> if a type cannot be inferred.</p> -<p>Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>principal_out</em> when it is no longer needed.</p> +<p>Use krb5_free_principal() to free <em>principal_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The realm in a Kerberos <em>name</em> cannot contain slash, colon, or NULL characters.</p> -</div> +<p class="admonition-title">Note</p> +<p>The realm in a Kerberos <em>name</em> cannot contain slash, colon, or NULL characters.</p> </div> +</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_parse_name - Convert a string principal name to a krb5_principal structure.</a></li> @@ -155,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -162,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_parse_name_flags.html b/doc/html/appdev/refs/api/krb5_parse_name_flags.html index d4c178494d21..2cdcba327985 100644 --- a/doc/html/appdev/refs/api/krb5_parse_name_flags.html +++ b/doc/html/appdev/refs/api/krb5_parse_name_flags.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_parse_name_flags - Convert a string principal name to a krb5_principal with flags. — 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_principal_compare - Compare two principals." href="krb5_principal_compare.html" /> <link rel="prev" title="krb5_parse_name - Convert a string principal name to a krb5_principal structure." href="krb5_parse_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,63 +52,57 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-parse-name-flags-convert-a-string-principal-name-to-a-krb5-principal-with-flags"> + <section id="krb5-parse-name-flags-convert-a-string-principal-name-to-a-krb5-principal-with-flags"> <h1>krb5_parse_name_flags - Convert a string principal name to a krb5_principal with flags.<a class="headerlink" href="#krb5-parse-name-flags-convert-a-string-principal-name-to-a-krb5-principal-with-flags" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_parse_name_flags"> -<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_parse_name_flags</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 char *<em> name</em>, int<em> flags</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> principal_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_parse_name_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_parse_name_flags"> +<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_parse_name_flags</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">principal_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_parse_name_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>name</strong> - String representation of a principal name</p> <p><strong>[in]</strong> <strong>flags</strong> - Flag</p> -<p class="last"><strong>[out]</strong> <strong>principal_out</strong> - New principal</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>principal_out</strong> - New principal</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Similar to <a class="reference internal" href="krb5_parse_name.html#c.krb5_parse_name" title="krb5_parse_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_parse_name()</span></code></a> , this function converts a single-string representation of a principal name to a krb5_principal structure.</p> +</dd> +</dl> +<p>Similar to krb5_parse_name(), this function converts a single-string representation of a principal name to a krb5_principal structure.</p> <p>The following flags are valid:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_PARSE_NO_REALM.html#KRB5_PRINCIPAL_PARSE_NO_REALM" title="KRB5_PRINCIPAL_PARSE_NO_REALM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_NO_REALM</span></code></a> - no realm must be present in <em>name</em></li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_PARSE_REQUIRE_REALM.html#KRB5_PRINCIPAL_PARSE_REQUIRE_REALM" title="KRB5_PRINCIPAL_PARSE_REQUIRE_REALM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_REQUIRE_REALM</span></code></a> - realm must be present in <em>name</em></li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_PARSE_ENTERPRISE.html#KRB5_PRINCIPAL_PARSE_ENTERPRISE" title="KRB5_PRINCIPAL_PARSE_ENTERPRISE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_ENTERPRISE</span></code></a> - create single-component enterprise principal</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_PARSE_IGNORE_REALM.html#KRB5_PRINCIPAL_PARSE_IGNORE_REALM" title="KRB5_PRINCIPAL_PARSE_IGNORE_REALM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_IGNORE_REALM</span></code></a> - ignore realm if present in <em>name</em></li> +<li><p>#KRB5_PRINCIPAL_PARSE_NO_REALM - no realm must be present in <em>name</em></p></li> +<li><p>#KRB5_PRINCIPAL_PARSE_REQUIRE_REALM - realm must be present in <em>name</em></p></li> +<li><p>#KRB5_PRINCIPAL_PARSE_ENTERPRISE - create single-component enterprise principal</p></li> +<li><p>#KRB5_PRINCIPAL_PARSE_IGNORE_REALM - ignore realm if present in <em>name</em></p></li> </ul> </div></blockquote> <p>If <strong>KRB5_PRINCIPAL_PARSE_NO_REALM</strong> or <strong>KRB5_PRINCIPAL_PARSE_IGNORE_REALM</strong> is specified in <em>flags</em> , the realm of the new principal will be empty. Otherwise, the default realm for <em>context</em> will be used if <em>name</em> does not specify a realm.</p> </div></blockquote> -<p>Use <a class="reference internal" href="krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></code></a> to free <em>principal_out</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_principal() to free <em>principal_out</em> when it is no longer needed.</p> +</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_parse_name_flags - Convert a string principal name to a krb5_principal with flags.</a></li> @@ -161,6 +146,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -168,8 +154,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_prepend_error_message.html b/doc/html/appdev/refs/api/krb5_prepend_error_message.html index 47de8c0f1391..e25835a19494 100644 --- a/doc/html/appdev/refs/api/krb5_prepend_error_message.html +++ b/doc/html/appdev/refs/api/krb5_prepend_error_message.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_prepend_error_message - Add a prefix to the message for an error code. — 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_principal2salt - Convert a principal name into the default salt for that principal." href="krb5_principal2salt.html" /> <link rel="prev" title="krb5_pac_get_client_info - Read client information from a PAC." href="krb5_pac_get_client_info.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-prepend-error-message-add-a-prefix-to-the-message-for-an-error-code"> + <section id="krb5-prepend-error-message-add-a-prefix-to-the-message-for-an-error-code"> <h1>krb5_prepend_error_message - Add a prefix to the message for an error code.<a class="headerlink" href="#krb5-prepend-error-message-add-a-prefix-to-the-message-for-an-error-code" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_prepend_error_message"> -void <code class="descname">krb5_prepend_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_prepend_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_prepend_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_prepend_error_message</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">ctx</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_prepend_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> -<p class="last"><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> +</dd> +</dl> <p>Format a message and prepend it to the current message for <em>code</em> . The prefix will be separated from the old message with a colon and space.</p> -</div> +</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_prepend_error_message - Add a prefix to the message for an error code.</a></li> @@ -131,6 +120,7 @@ void <code class="descname">krb5_prepend_error_message</code><span class="sig-pa <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ void <code class="descname">krb5_prepend_error_message</code><span class="sig-pa <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_principal2salt.html b/doc/html/appdev/refs/api/krb5_principal2salt.html index b5a196217416..324eb1e2e80d 100644 --- a/doc/html/appdev/refs/api/krb5_principal2salt.html +++ b/doc/html/appdev/refs/api/krb5_principal2salt.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_principal2salt - Convert a principal name into the default salt for that principal. — 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_rd_cred - Read and validate a KRB-CRED message." href="krb5_rd_cred.html" /> <link rel="prev" title="krb5_prepend_error_message - Add a prefix to the message for an error code." href="krb5_prepend_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-principal2salt-convert-a-principal-name-into-the-default-salt-for-that-principal"> + <section id="krb5-principal2salt-convert-a-principal-name-into-the-default-salt-for-that-principal"> <h1>krb5_principal2salt - Convert a principal name into the default salt for that principal.<a class="headerlink" href="#krb5-principal2salt-convert-a-principal-name-into-the-default-salt-for-that-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_principal2salt"> -<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_principal2salt</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> pr</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> ret</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal2salt" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_principal2salt"> +<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_principal2salt</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">pr</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">ret</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal2salt" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>pr</strong> - Principal name</p> -<p class="last"><strong>[out]</strong> <strong>ret</strong> - Default salt for <em>pr</em> to be filled in</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>ret</strong> - Default salt for <em>pr</em> to be filled in</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> -</div> +</dd> +</dl> +</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_principal2salt - Convert a principal name into the default salt for that principal.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_principal_compare.html b/doc/html/appdev/refs/api/krb5_principal_compare.html index d104abaea3fb..e91ef239bd72 100644 --- a/doc/html/appdev/refs/api/krb5_principal_compare.html +++ b/doc/html/appdev/refs/api/krb5_principal_compare.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_principal_compare - Compare two principals. — 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_principal_compare_any_realm - Compare two principals ignoring realm components." href="krb5_principal_compare_any_realm.html" /> <link rel="prev" title="krb5_parse_name_flags - Convert a string principal name to a krb5_principal with flags." href="krb5_parse_name_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-principal-compare-compare-two-principals"> + <section id="krb5-principal-compare-compare-two-principals"> <h1>krb5_principal_compare - Compare two principals.<a class="headerlink" href="#krb5-principal-compare-compare-two-principals" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_principal_compare"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_principal_compare</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ1</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ2</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_principal_compare"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_principal_compare</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ1</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ2</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>princ1</strong> - First principal</p> -<p class="last"><strong>[in]</strong> <strong>princ2</strong> - Second principal</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>TRUE if the principals are the same; FALSE otherwise</li> +<p><strong>[in]</strong> <strong>princ2</strong> - Second principal</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the principals are the same; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_principal_compare - Compare two principals.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_principal_compare_any_realm.html b/doc/html/appdev/refs/api/krb5_principal_compare_any_realm.html index 79b390f2db5e..23b8e2149dc5 100644 --- a/doc/html/appdev/refs/api/krb5_principal_compare_any_realm.html +++ b/doc/html/appdev/refs/api/krb5_principal_compare_any_realm.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_principal_compare_any_realm - Compare two principals ignoring realm components. — 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_principal_compare_flags - Compare two principals with additional flags." href="krb5_principal_compare_flags.html" /> <link rel="prev" title="krb5_principal_compare - Compare two principals." href="krb5_principal_compare.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-principal-compare-any-realm-compare-two-principals-ignoring-realm-components"> + <section id="krb5-principal-compare-any-realm-compare-two-principals-ignoring-realm-components"> <h1>krb5_principal_compare_any_realm - Compare two principals ignoring realm components.<a class="headerlink" href="#krb5-principal-compare-any-realm-compare-two-principals-ignoring-realm-components" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_principal_compare_any_realm"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_principal_compare_any_realm</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ1</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ2</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare_any_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_principal_compare_any_realm"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_principal_compare_any_realm</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ1</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ2</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare_any_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>princ1</strong> - First principal</p> -<p class="last"><strong>[in]</strong> <strong>princ2</strong> - Second principal</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>TRUE if the principals are the same; FALSE otherwise</li> +<p><strong>[in]</strong> <strong>princ2</strong> - Second principal</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the principals are the same; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Similar to <a class="reference internal" href="krb5_principal_compare.html#c.krb5_principal_compare" title="krb5_principal_compare"><code class="xref c c-func docutils literal"><span class="pre">krb5_principal_compare()</span></code></a> , but do not compare the realm components of the principals.</p> -</div> +</dd> +</dl> +<p>Similar to krb5_principal_compare(), but do not compare the realm components of the principals.</p> +</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_principal_compare_any_realm - Compare two principals ignoring realm components.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_principal_compare_flags.html b/doc/html/appdev/refs/api/krb5_principal_compare_flags.html index 7029b14ce30e..b32ea27ce770 100644 --- a/doc/html/appdev/refs/api/krb5_principal_compare_flags.html +++ b/doc/html/appdev/refs/api/krb5_principal_compare_flags.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_principal_compare_flags - Compare two principals with additional flags. — 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_prompter_posix - Prompt user for password." href="krb5_prompter_posix.html" /> <link rel="prev" title="krb5_principal_compare_any_realm - Compare two principals ignoring realm components." href="krb5_principal_compare_any_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,57 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-principal-compare-flags-compare-two-principals-with-additional-flags"> + <section id="krb5-principal-compare-flags-compare-two-principals-with-additional-flags"> <h1>krb5_principal_compare_flags - Compare two principals with additional flags.<a class="headerlink" href="#krb5-principal-compare-flags-compare-two-principals-with-additional-flags" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_principal_compare_flags"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_principal_compare_flags</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ1</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ2</em>, int<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_principal_compare_flags"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_principal_compare_flags</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ1</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ2</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_principal_compare_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>princ1</strong> - First principal</p> <p><strong>[in]</strong> <strong>princ2</strong> - Second principal</p> -<p class="last"><strong>[in]</strong> <strong>flags</strong> - Flags</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>TRUE if the principal names are the same; FALSE otherwise</li> +<p><strong>[in]</strong> <strong>flags</strong> - Flags</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the principal names are the same; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Valid flags are:</p> <blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_COMPARE_IGNORE_REALM.html#KRB5_PRINCIPAL_COMPARE_IGNORE_REALM" title="KRB5_PRINCIPAL_COMPARE_IGNORE_REALM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_COMPARE_IGNORE_REALM</span></code></a> - ignore realm component</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_COMPARE_ENTERPRISE.html#KRB5_PRINCIPAL_COMPARE_ENTERPRISE" title="KRB5_PRINCIPAL_COMPARE_ENTERPRISE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_COMPARE_ENTERPRISE</span></code></a> - UPNs as real principals</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_COMPARE_CASEFOLD.html#KRB5_PRINCIPAL_COMPARE_CASEFOLD" title="KRB5_PRINCIPAL_COMPARE_CASEFOLD"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_COMPARE_CASEFOLD</span></code></a> case-insensitive</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_COMPARE_UTF8.html#KRB5_PRINCIPAL_COMPARE_UTF8" title="KRB5_PRINCIPAL_COMPARE_UTF8"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_COMPARE_UTF8</span></code></a> - treat principals as UTF-8</li> +<li><p>#KRB5_PRINCIPAL_COMPARE_IGNORE_REALM - ignore realm component</p></li> +<li><p>#KRB5_PRINCIPAL_COMPARE_ENTERPRISE - UPNs as real principals</p></li> +<li><p>#KRB5_PRINCIPAL_COMPARE_CASEFOLD case-insensitive</p></li> +<li><p>#KRB5_PRINCIPAL_COMPARE_UTF8 - treat principals as UTF-8</p></li> </ul> </div></blockquote> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_principal_compare.html#c.krb5_principal_compare" title="krb5_principal_compare"><code class="xref c c-func docutils literal"><span class="pre">krb5_principal_compare()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_principal_compare()</p> </div> +</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_principal_compare_flags - Compare two principals with additional flags.</a></li> @@ -155,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -162,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_process_key.html b/doc/html/appdev/refs/api/krb5_process_key.html index 758fcd0b732a..374053afe13e 100644 --- a/doc/html/appdev/refs/api/krb5_process_key.html +++ b/doc/html/appdev/refs/api/krb5_process_key.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_process_key — 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_string_to_key" href="krb5_string_to_key.html" /> <link rel="prev" title="krb5_random_key" href="krb5_random_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-process-key"> + <section id="krb5-process-key"> <h1>krb5_process_key<a class="headerlink" href="#krb5-process-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_process_key"> -<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_process_key</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, const <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> key</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_process_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_process_key"> +<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_process_key</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</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><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_process_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> -<p class="last"><strong>key</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>key</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_process_key</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_prompter_posix.html b/doc/html/appdev/refs/api/krb5_prompter_posix.html index e7f36020a11d..67b03c047103 100644 --- a/doc/html/appdev/refs/api/krb5_prompter_posix.html +++ b/doc/html/appdev/refs/api/krb5_prompter_posix.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_prompter_posix - Prompt user for password. — 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_realm_compare - Compare the realms of two principals." href="krb5_realm_compare.html" /> <link rel="prev" title="krb5_principal_compare_flags - Compare two principals with additional flags." href="krb5_principal_compare_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-prompter-posix-prompt-user-for-password"> + <section id="krb5-prompter-posix-prompt-user-for-password"> <h1>krb5_prompter_posix - Prompt user for password.<a class="headerlink" href="#krb5-prompter-posix-prompt-user-for-password" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_prompter_posix"> -<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_prompter_posix</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>, void *<em> data</em>, const char *<em> name</em>, const char *<em> banner</em>, int<em> num_prompts</em>, <a class="reference internal" href="../types/krb5_prompt.html#c.krb5_prompt" title="krb5_prompt">krb5_prompt</a><em> prompts</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_prompter_posix" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_prompter_posix"> +<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_prompter_posix</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="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">banner</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">num_prompts</span></span>, <a class="reference internal" href="../types/krb5_prompt.html#c.krb5_prompt" title="krb5_prompt"><span class="n"><span class="pre">krb5_prompt</span></span></a><span class="w"> </span><span class="n"><span class="pre">prompts</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_prompter_posix" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>data</strong> - Unused (callback argument)</p> <p><strong>[in]</strong> <strong>name</strong> - Name to output during prompt</p> <p><strong>[in]</strong> <strong>banner</strong> - Banner to output during prompt</p> <p><strong>[in]</strong> <strong>num_prompts</strong> - Number of prompts in <em>prompts</em></p> -<p class="last"><strong>[in]</strong> <strong>prompts</strong> - Array of prompts and replies</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>prompts</strong> - Array of prompts and replies</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function is intended to be used as a prompter callback for <a class="reference internal" href="krb5_get_init_creds_password.html#c.krb5_get_init_creds_password" title="krb5_get_init_creds_password"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_init_creds_password()</span></code></a> or <a class="reference internal" href="krb5_init_creds_init.html#c.krb5_init_creds_init" title="krb5_init_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_init_creds_init()</span></code></a> .</p> +</dd> +</dl> +<p>This function is intended to be used as a prompter callback for krb5_get_init_creds_password() or krb5_init_creds_init().</p> <p>Writes <em>name</em> and <em>banner</em> to stdout, each followed by a newline, then writes each prompt field in the <em>prompts</em> array, followed by”:”, and sets the reply field of the entry to a line of input read from stdin. If the hidden flag is set for a prompt, then terminal echoing is turned off when input is read.</p> -</div> +</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_prompter_posix - Prompt user for password.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_random_key.html b/doc/html/appdev/refs/api/krb5_random_key.html index 491aa6f5c54a..cd4338f8e613 100644 --- a/doc/html/appdev/refs/api/krb5_random_key.html +++ b/doc/html/appdev/refs/api/krb5_random_key.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_random_key — 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_process_key" href="krb5_process_key.html" /> <link rel="prev" title="krb5_kt_free_entry" href="krb5_kt_free_entry.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-random-key"> + <section id="krb5-random-key"> <h1>krb5_random_key<a class="headerlink" href="#krb5-random-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_random_key"> -<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_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> ptr</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> **<em> keyblock</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_random_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_random_key"> +<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_random_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">ptr</span></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="p"><span class="pre">*</span></span><span class="n"><span class="pre">keyblock</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_random_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> <p><strong>ptr</strong></p> -<p class="last"><strong>keyblock</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>keyblock</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_random_key</a></li> @@ -132,6 +121,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_cred.html b/doc/html/appdev/refs/api/krb5_rd_cred.html index 50001fdfddbf..4ef508fd36fe 100644 --- a/doc/html/appdev/refs/api/krb5_rd_cred.html +++ b/doc/html/appdev/refs/api/krb5_rd_cred.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_rd_cred - Read and validate a KRB-CRED message. — 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_rd_error - Decode a KRB-ERROR message." href="krb5_rd_error.html" /> <link rel="prev" title="krb5_principal2salt - Convert a principal name into the default salt for that principal." href="krb5_principal2salt.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-cred-read-and-validate-a-krb-cred-message"> + <section id="krb5-rd-cred-read-and-validate-a-krb-cred-message"> <h1>krb5_rd_cred - Read and validate a KRB-CRED message.<a class="headerlink" href="#krb5-rd-cred-read-and-validate-a-krb-cred-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_cred"> -<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_cred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> creddata</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> ***<em> creds_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_cred" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_cred"> +<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_rd_cred</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">creddata</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_cred" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>creddata</strong> - <strong>KRB-CRED</strong> message</p> <p><strong>[out]</strong> <strong>creds_out</strong> - Null-terminated array of forwarded credentials</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay data (NULL if not needed)</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>rdata_out</strong> - Replay data (NULL if not needed)</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> <blockquote> -<div><em>creddata</em> will be decrypted using the receiving subkey if it is present in <em>auth_context</em> , or the session key if the receiving subkey is not present or fails to decrypt the message.</div></blockquote> -<p>Use <a class="reference internal" href="krb5_free_tgt_creds.html#c.krb5_free_tgt_creds" title="krb5_free_tgt_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_tgt_creds()</span></code></a> to free <em>creds_out</em> when it is no longer needed.</p> +<div><p><em>creddata</em> will be decrypted using the receiving subkey if it is present in <em>auth_context</em> , or the session key if the receiving subkey is not present or fails to decrypt the message.</p> +</div></blockquote> +<p>Use krb5_free_tgt_creds() to free <em>creds_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .`</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .`</p> </div> +</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_rd_cred - Read and validate a KRB-CRED message.</a></li> @@ -150,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_error.html b/doc/html/appdev/refs/api/krb5_rd_error.html index b499b1413d0d..9eadc7893012 100644 --- a/doc/html/appdev/refs/api/krb5_rd_error.html +++ b/doc/html/appdev/refs/api/krb5_rd_error.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_rd_error - Decode a KRB-ERROR message. — 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_rd_priv - Process a KRB-PRIV message." href="krb5_rd_priv.html" /> <link rel="prev" title="krb5_rd_cred - Read and validate a KRB-CRED message." href="krb5_rd_cred.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-error-decode-a-krb-error-message"> + <section id="krb5-rd-error-decode-a-krb-error-message"> <h1>krb5_rd_error - Decode a KRB-ERROR message.<a class="headerlink" href="#krb5-rd-error-decode-a-krb-error-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_error"> -<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_error</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> enc_errbuf</em>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> **<em> dec_error</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_error" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_error"> +<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_rd_error</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_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">enc_errbuf</span></span>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">dec_error</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_error" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>enc_errbuf</strong> - Encoded error message</p> -<p class="last"><strong>[out]</strong> <strong>dec_error</strong> - Decoded error message</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>dec_error</strong> - Decoded error message</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> -<p>This function processes <strong>KRB-ERROR</strong> message <em>enc_errbuf</em> and returns an allocated structure <em>dec_error</em> containing the error message. Use <a class="reference internal" href="krb5_free_error.html#c.krb5_free_error" title="krb5_free_error"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_error()</span></code></a> to free <em>dec_error</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>This function processes <strong>KRB-ERROR</strong> message <em>enc_errbuf</em> and returns an allocated structure <em>dec_error</em> containing the error message. Use krb5_free_error() to free <em>dec_error</em> when it is no longer needed.</p> +</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_rd_error - Decode a KRB-ERROR message.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_priv.html b/doc/html/appdev/refs/api/krb5_rd_priv.html index 33d335f618cf..490134e68f70 100644 --- a/doc/html/appdev/refs/api/krb5_rd_priv.html +++ b/doc/html/appdev/refs/api/krb5_rd_priv.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_rd_priv - Process a KRB-PRIV message. — 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_rd_rep - Parse and decrypt a KRB_AP_REP message." href="krb5_rd_rep.html" /> <link rel="prev" title="krb5_rd_error - Decode a KRB-ERROR message." href="krb5_rd_error.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-priv-process-a-krb-priv-message"> + <section id="krb5-rd-priv-process-a-krb-priv-message"> <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> -<dl class="function"> -<dt id="c.krb5_rd_priv"> -<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><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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> inbuf</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> userdata_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_priv" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_priv"> +<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_rd_priv</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">inbuf</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">userdata_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_priv" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication structure</p> <p><strong>[in]</strong> <strong>inbuf</strong> - <strong>KRB-PRIV</strong> message to be parsed</p> <p><strong>[out]</strong> <strong>userdata_out</strong> - Data parsed from <strong>KRB-PRIV</strong> message</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay data. Specify NULL if not needed</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>rdata_out</strong> - Replay data. Specify NULL if not needed</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 parses a <strong>KRB-PRIV</strong> message, verifies its integrity, and stores its unencrypted data into <em>userdata_out</em> .</p> <p>If <em>auth_context</em> has a remote address set, the address will be used to verify the sender address in the KRB-PRIV message. If <em>auth_context</em> has a local address set, it will be used to verify the receiver address in the KRB-PRIV message if the message contains one.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> , the sequence number of the KRB-PRIV message is checked against the remote sequence number field of <em>auth_context</em> . Otherwise, the sequence number is not used.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> flag is set in <em>auth_context</em> , 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.</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>userdata_out</em> when it is no longer needed.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag is set in <em>auth_context</em> , the sequence number of the KRB-PRIV message is checked against the remote sequence number field of <em>auth_context</em> . Otherwise, the sequence number is not used.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in <em>auth_context</em> , 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.</p> +<p>Use krb5_free_data_contents() to free <em>userdata_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .</p> </div> +</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_rd_priv - Process a KRB-PRIV message.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_rep.html b/doc/html/appdev/refs/api/krb5_rd_rep.html index 39e9aa8f40fb..e9f96fbf2ea6 100644 --- a/doc/html/appdev/refs/api/krb5_rd_rep.html +++ b/doc/html/appdev/refs/api/krb5_rd_rep.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_rd_rep - Parse and decrypt a KRB_AP_REP message. — 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_rd_rep_dce - Parse and decrypt a KRB_AP_REP message for DCE RPC." href="krb5_rd_rep_dce.html" /> <link rel="prev" title="krb5_rd_priv - Process a KRB-PRIV message." href="krb5_rd_priv.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,46 +52,40 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-rep-parse-and-decrypt-a-krb-ap-rep-message"> + <section id="krb5-rd-rep-parse-and-decrypt-a-krb-ap-rep-message"> <h1>krb5_rd_rep - Parse and decrypt a KRB_AP_REP message.<a class="headerlink" href="#krb5-rd-rep-parse-and-decrypt-a-krb-ap-rep-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_rep"> -<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_rep</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> inbuf</em>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part">krb5_ap_rep_enc_part</a> **<em> repl</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_rep" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_rep"> +<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_rd_rep</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">inbuf</span></span>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part"><span class="n"><span class="pre">krb5_ap_rep_enc_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">repl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_rep" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>inbuf</strong> - AP-REP message</p> -<p class="last"><strong>[out]</strong> <strong>repl</strong> - Decrypted reply message</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>repl</strong> - Decrypted reply message</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 parses, decrypts and verifies a message from <em>inbuf</em> and fills in <em>repl</em> with a pointer to allocated memory containing the fields from the encrypted response.</p> -<p>Use <a class="reference internal" href="krb5_free_ap_rep_enc_part.html#c.krb5_free_ap_rep_enc_part" title="krb5_free_ap_rep_enc_part"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_ap_rep_enc_part()</span></code></a> to free <em>repl</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_ap_rep_enc_part() to free <em>repl</em> when it is no longer needed.</p> +</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_rd_rep - Parse and decrypt a KRB_AP_REP message.</a></li> @@ -144,6 +129,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -151,8 +137,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_rep_dce.html b/doc/html/appdev/refs/api/krb5_rd_rep_dce.html index b17d8f057a4d..6c1b92be2210 100644 --- a/doc/html/appdev/refs/api/krb5_rd_rep_dce.html +++ b/doc/html/appdev/refs/api/krb5_rd_rep_dce.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_rd_rep_dce - Parse and decrypt a KRB_AP_REP message for DCE RPC. — 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_rd_req - Parse and decrypt a KRB_AP_REQ message." href="krb5_rd_req.html" /> <link rel="prev" title="krb5_rd_rep - Parse and decrypt a KRB_AP_REP message." href="krb5_rd_rep.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-rep-dce-parse-and-decrypt-a-krb-ap-rep-message-for-dce-rpc"> + <section id="krb5-rd-rep-dce-parse-and-decrypt-a-krb-ap-rep-message-for-dce-rpc"> <h1>krb5_rd_rep_dce - Parse and decrypt a KRB_AP_REP message for DCE RPC.<a class="headerlink" href="#krb5-rd-rep-dce-parse-and-decrypt-a-krb-ap-rep-message-for-dce-rpc" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_rep_dce"> -<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_rep_dce</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> inbuf</em>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4">krb5_ui_4</a> *<em> nonce</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_rep_dce" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_rep_dce"> +<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_rd_rep_dce</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">inbuf</span></span>, <a class="reference internal" href="../types/krb5_ui_4.html#c.krb5_ui_4" title="krb5_ui_4"><span class="n"><span class="pre">krb5_ui_4</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">nonce</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_rep_dce" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>inbuf</strong> - AP-REP message</p> -<p class="last"><strong>[out]</strong> <strong>nonce</strong> - Sequence number from the decrypted reply</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>nonce</strong> - Sequence number from the decrypted reply</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 parses, decrypts and verifies a message from <em>inbuf</em> and fills in <em>nonce</em> with a decrypted reply sequence number.</p> -</div> +</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_rd_rep_dce - Parse and decrypt a KRB_AP_REP message for DCE RPC.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_req.html b/doc/html/appdev/refs/api/krb5_rd_req.html index 8e7e2912af89..9f25dad04564 100644 --- a/doc/html/appdev/refs/api/krb5_rd_req.html +++ b/doc/html/appdev/refs/api/krb5_rd_req.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_rd_req - Parse and decrypt a KRB_AP_REQ message. — 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_rd_safe - Process KRB-SAFE message." href="krb5_rd_safe.html" /> <link rel="prev" title="krb5_rd_rep_dce - Parse and decrypt a KRB_AP_REP message for DCE RPC." href="krb5_rd_rep_dce.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,63 +52,57 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-req-parse-and-decrypt-a-krb-ap-req-message"> + <section id="krb5-rd-req-parse-and-decrypt-a-krb-ap-req-message"> <h1>krb5_rd_req - Parse and decrypt a KRB_AP_REQ message.<a class="headerlink" href="#krb5-rd-req-parse-and-decrypt-a-krb-ap-req-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_req"> -<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_req</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> inbuf</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a> *<em> ap_req_options</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> **<em> ticket</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_req" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_req"> +<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_rd_req</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</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">inbuf</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ap_req_options</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ticket</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_req" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> <p><strong>[in]</strong> <strong>inbuf</strong> - AP-REQ message to be parsed</p> <p><strong>[in]</strong> <strong>server</strong> - Matching principal for server, or NULL to allow any principal in keytab</p> <p><strong>[in]</strong> <strong>keytab</strong> - Key table, or NULL to use the default</p> <p><strong>[out]</strong> <strong>ap_req_options</strong> - If non-null, the AP-REQ flags on output</p> -<p class="last"><strong>[out]</strong> <strong>ticket</strong> - If non-null, ticket from the AP-REQ message</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>ticket</strong> - If non-null, ticket from the AP-REQ message</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 parses, decrypts and verifies a AP-REQ message from <em>inbuf</em> and stores the authenticator in <em>auth_context</em> .</p> -<p>If a keyblock was specified in <em>auth_context</em> using <a class="reference internal" href="krb5_auth_con_setuseruserkey.html#c.krb5_auth_con_setuseruserkey" title="krb5_auth_con_setuseruserkey"><code class="xref c c-func docutils literal"><span class="pre">krb5_auth_con_setuseruserkey()</span></code></a> , that key is used to decrypt the ticket in AP-REQ message and <em>keytab</em> is ignored. In this case, <em>server</em> should be specified as a complete principal name to allow for proper transited-path checking and replay cache selection.</p> -<p>Otherwise, the decryption key is obtained from <em>keytab</em> , or from the default keytab if it is NULL. In this case, <em>server</em> may be a complete principal name, a matching principal (see <a class="reference internal" href="krb5_sname_match.html#c.krb5_sname_match" title="krb5_sname_match"><code class="xref c c-func docutils literal"><span class="pre">krb5_sname_match()</span></code></a> ), or NULL to match any principal name. The keys tried against the encrypted part of the ticket are determined as follows:</p> +<p>If a keyblock was specified in <em>auth_context</em> using krb5_auth_con_setuseruserkey(), that key is used to decrypt the ticket in AP-REQ message and <em>keytab</em> is ignored. In this case, <em>server</em> should be specified as a complete principal name to allow for proper transited-path checking and replay cache selection.</p> +<p>Otherwise, the decryption key is obtained from <em>keytab</em> , or from the default keytab if it is NULL. In this case, <em>server</em> may be a complete principal name, a matching principal (see krb5_sname_match()), or NULL to match any principal name. The keys tried against the encrypted part of the ticket are determined as follows:</p> <blockquote> <div><ul class="simple"> -<li>If <em>server</em> is a complete principal name, then its entry in <em>keytab</em> is tried.</li> -<li>Otherwise, if <em>keytab</em> is iterable, then all entries in <em>keytab</em> which match <em>server</em> are tried.</li> -<li>Otherwise, the server principal in the ticket must match <em>server</em> , and its entry in <em>keytab</em> is tried.</li> +<li><p>If <em>server</em> is a complete principal name, then its entry in <em>keytab</em> is tried.</p></li> +<li><p>Otherwise, if <em>keytab</em> is iterable, then all entries in <em>keytab</em> which match <em>server</em> are tried.</p></li> +<li><p>Otherwise, the server principal in the ticket must match <em>server</em> , and its entry in <em>keytab</em> is tried.</p></li> </ul> </div></blockquote> <p>The client specified in the decrypted authenticator must match the client specified in the decrypted ticket.</p> <p>If the <em>remote_addr</em> field of <em>auth_context</em> is set, the request must come from that address.</p> <p>If a replay cache handle is provided in the <em>auth_context</em> , the authenticator and ticket are verified against it. If no conflict is found, the new authenticator is then stored in the replay cache of <em>auth_context</em> .</p> <p>Various other checks are performed on the decoded data, including cross-realm policy, clockskew, and ticket validation times.</p> -<p>On success the authenticator, subkey, and remote sequence number of the request are stored in <em>auth_context</em> . If the <a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></code></a> bit is set, the local sequence number is XORed with the remote sequence number in the request.</p> -<p>Use <a class="reference internal" href="krb5_free_ticket.html#c.krb5_free_ticket" title="krb5_free_ticket"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_ticket()</span></code></a> to free <em>ticket</em> when it is no longer needed.</p> -</div> +<p>On success the authenticator, subkey, and remote sequence number of the request are stored in <em>auth_context</em> . If the #AP_OPTS_MUTUAL_REQUIRED bit is set, the local sequence number is XORed with the remote sequence number in the request.</p> +<p>Use krb5_free_ticket() to free <em>ticket</em> when it is no longer needed.</p> +</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_rd_req - Parse and decrypt a KRB_AP_REQ message.</a></li> @@ -161,6 +146,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -168,8 +154,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_rd_safe.html b/doc/html/appdev/refs/api/krb5_rd_safe.html index 471630c45e47..7559b1cf03ac 100644 --- a/doc/html/appdev/refs/api/krb5_rd_safe.html +++ b/doc/html/appdev/refs/api/krb5_rd_safe.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_rd_safe - Process KRB-SAFE message. — 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_read_password - Read a password from keyboard input." href="krb5_read_password.html" /> <link rel="prev" title="krb5_rd_req - Parse and decrypt a KRB_AP_REQ message." href="krb5_rd_req.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-rd-safe-process-krb-safe-message"> + <section id="krb5-rd-safe-process-krb-safe-message"> <h1>krb5_rd_safe - Process KRB-SAFE message.<a class="headerlink" href="#krb5-rd-safe-process-krb-safe-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_rd_safe"> -<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_safe</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a><em> auth_context</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> inbuf</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> userdata_out</em>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data">krb5_replay_data</a> *<em> rdata_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_safe" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_rd_safe"> +<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_rd_safe</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">auth_context</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">inbuf</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">userdata_out</span></span>, <a class="reference internal" href="../types/krb5_replay_data.html#c.krb5_replay_data" title="krb5_replay_data"><span class="n"><span class="pre">krb5_replay_data</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rdata_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_rd_safe" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>auth_context</strong> - Authentication context</p> <p><strong>[in]</strong> <strong>inbuf</strong> - <strong>KRB-SAFE</strong> message to be parsed</p> <p><strong>[out]</strong> <strong>userdata_out</strong> - Data parsed from <strong>KRB-SAFE</strong> message</p> -<p class="last"><strong>[out]</strong> <strong>rdata_out</strong> - Replay data. Specify NULL if not needed</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>rdata_out</strong> - Replay data. Specify NULL if not needed</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 parses a <strong>KRB-SAFE</strong> message, verifies its integrity, and stores its data into <em>userdata_out</em> .</p> <p>If <em>auth_context</em> has a remote address set, the address will be used to verify the sender address in the KRB-SAFE message. If <em>auth_context</em> has a local address set, it will be used to verify the receiver address in the KRB-SAFE message if the message contains one.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> , the sequence number of the KRB-SAFE message is checked against the remote sequence number field of <em>auth_context</em> . Otherwise, the sequence number is not used.</p> -<p>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"><span class="pre">KRB5_AUTH_CONTEXT_DO_TIME</span></code></a> flag is set in <em>auth_context</em> , 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.</p> -<p>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"><span class="pre">krb5_free_data_contents()</span></code></a> to free <em>userdata_out</em> when it is no longer needed.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_SEQUENCE flag is set in <em>auth_context</em> , the sequence number of the KRB-SAFE message is checked against the remote sequence number field of <em>auth_context</em> . Otherwise, the sequence number is not used.</p> +<p>If the #KRB5_AUTH_CONTEXT_DO_TIME flag is set in <em>auth_context</em> , 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.</p> +<p>Use krb5_free_data_contents() to free <em>userdata_out</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">The <em>rdata_out</em> 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"><span class="pre">KRB5_AUTH_CONTEXT_RET_TIME</span></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"><span class="pre">KRB5_AUTH_CONTEXT_RET_SEQUENCE</span></code></a> flag is set in <em>auth_context</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>The <em>rdata_out</em> argument is required if the #KRB5_AUTH_CONTEXT_RET_TIME or #KRB5_AUTH_CONTEXT_RET_SEQUENCE flag is set in <em>auth_context</em> .</p> </div> +</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_rd_safe - Process KRB-SAFE message.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_read_password.html b/doc/html/appdev/refs/api/krb5_read_password.html index 3f80a52ead36..0e5d899f6ecb 100644 --- a/doc/html/appdev/refs/api/krb5_read_password.html +++ b/doc/html/appdev/refs/api/krb5_read_password.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_read_password - Read a password from keyboard input. — 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_salttype_to_string - Convert a salt type to a string." href="krb5_salttype_to_string.html" /> <link rel="prev" title="krb5_rd_safe - Process KRB-SAFE message." href="krb5_rd_safe.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,56 +52,51 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-read-password-read-a-password-from-keyboard-input"> + <section id="krb5-read-password-read-a-password-from-keyboard-input"> <h1>krb5_read_password - Read a password from keyboard input.<a class="headerlink" href="#krb5-read-password-read-a-password-from-keyboard-input" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_read_password"> -<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_read_password</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 char *<em> prompt</em>, const char *<em> prompt2</em>, char *<em> return_pwd</em>, unsigned int *<em> size_return</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_read_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_read_password"> +<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_read_password</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">prompt</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">prompt2</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">return_pwd</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size_return</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_read_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>prompt</strong> - First user prompt when reading password</p> <p><strong>[in]</strong> <strong>prompt2</strong> - Second user prompt (NULL to prompt only once)</p> <p><strong>[out]</strong> <strong>return_pwd</strong> - Returned password</p> -<p class="last"><strong>[inout]</strong> <strong>size_return</strong> - On input, maximum size of password; on output, size of password read</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 simple"> -<li>0 Success</li> +<p><strong>[inout]</strong> <strong>size_return</strong> - On input, maximum size of password; on output, size of password read</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Error in reading or verifying the password</li> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Error in reading or verifying the password</p></li> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function reads a password from keyboard input and stores it in <em>return_pwd</em> . <em>size_return</em> should be set by the caller to the amount of storage space available in <em>return_pwd</em> ; on successful return, it will be set to the length of the password read.</p> <blockquote> -<div><em>prompt</em> is printed to the terminal, followed by”:”, and then a password is read from the keyboard.</div></blockquote> +<div><p><em>prompt</em> is printed to the terminal, followed by”:”, and then a password is read from the keyboard.</p> +</div></blockquote> <p>If <em>prompt2</em> is NULL, the password is read only once. Otherwise, <em>prompt2</em> is printed to the terminal and a second password is read. If the two passwords entered are not identical, KRB5_LIBOS_BADPWDMATCH is returned.</p> <p>Echoing is turned off when the password is read.</p> -</div> +</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_read_password - Read a password from keyboard input.</a></li> @@ -154,6 +140,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -161,8 +148,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_realm_compare.html b/doc/html/appdev/refs/api/krb5_realm_compare.html index 5ebc5395ca05..72baaeef5f9c 100644 --- a/doc/html/appdev/refs/api/krb5_realm_compare.html +++ b/doc/html/appdev/refs/api/krb5_realm_compare.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_realm_compare - Compare the realms of two principals. — 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_responder_get_challenge - Retrieve the challenge data for a given question in the responder context." href="krb5_responder_get_challenge.html" /> <link rel="prev" title="krb5_prompter_posix - Prompt user for password." href="krb5_prompter_posix.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-realm-compare-compare-the-realms-of-two-principals"> + <section id="krb5-realm-compare-compare-the-realms-of-two-principals"> <h1>krb5_realm_compare - Compare the realms of two principals.<a class="headerlink" href="#krb5-realm-compare-compare-the-realms-of-two-principals" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_realm_compare"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_realm_compare</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ1</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ2</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_realm_compare" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_realm_compare"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_realm_compare</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ1</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ2</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_realm_compare" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>princ1</strong> - First principal</p> -<p class="last"><strong>[in]</strong> <strong>princ2</strong> - Second principal</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>TRUE if the realm names are the same; FALSE otherwise</li> +<p><strong>[in]</strong> <strong>princ2</strong> - Second principal</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if the realm names are the same; FALSE otherwise</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_realm_compare - Compare the realms of two principals.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_recvauth.html b/doc/html/appdev/refs/api/krb5_recvauth.html index 5b4a7a5a0ec5..85e5983a883f 100644 --- a/doc/html/appdev/refs/api/krb5_recvauth.html +++ b/doc/html/appdev/refs/api/krb5_recvauth.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_recvauth - Server function for sendauth protocol. — 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_recvauth_version - Server function for sendauth protocol with version parameter." href="krb5_recvauth_version.html" /> <link rel="prev" title="krb5_k_verify_checksum_iov - Validate a checksum element in IOV array (operates on opaque key)." href="krb5_k_verify_checksum_iov.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,54 +52,48 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-recvauth-server-function-for-sendauth-protocol"> + <section id="krb5-recvauth-server-function-for-sendauth-protocol"> <h1>krb5_recvauth - Server function for sendauth protocol.<a class="headerlink" href="#krb5-recvauth-server-function-for-sendauth-protocol" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_recvauth"> -<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_recvauth</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> fd</em>, char *<em> appl_version</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> flags</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> **<em> ticket</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_recvauth" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_recvauth"> +<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_recvauth</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">fd</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">appl_version</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ticket</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_recvauth" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> <p><strong>[in]</strong> <strong>fd</strong> - File descriptor</p> <p><strong>[in]</strong> <strong>appl_version</strong> - Application protocol version to be matched against the client’s application version</p> <p><strong>[in]</strong> <strong>server</strong> - Server principal (NULL for any in <em>keytab</em> )</p> <p><strong>[in]</strong> <strong>flags</strong> - Additional specifications</p> <p><strong>[in]</strong> <strong>keytab</strong> - Key table containing service keys</p> -<p class="last"><strong>[out]</strong> <strong>ticket</strong> - Ticket (NULL if not needed)</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>ticket</strong> - Ticket (NULL if not needed)</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 performs the server side of a sendauth/recvauth exchange by sending and receiving messages over <em>fd</em> .</p> -<p>Use <a class="reference internal" href="krb5_free_ticket.html#c.krb5_free_ticket" title="krb5_free_ticket"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_ticket()</span></code></a> to free <em>ticket</em> when it is no longer needed.</p> +<p>Use krb5_free_ticket() to free <em>ticket</em> when it is no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_sendauth.html#c.krb5_sendauth" title="krb5_sendauth"><code class="xref c c-func docutils literal"><span class="pre">krb5_sendauth()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_sendauth()</p> </div> +</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_recvauth - Server function for sendauth protocol.</a></li> @@ -152,6 +137,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -159,8 +145,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_recvauth_version.html b/doc/html/appdev/refs/api/krb5_recvauth_version.html index 1b229226f96b..6729f343772a 100644 --- a/doc/html/appdev/refs/api/krb5_recvauth_version.html +++ b/doc/html/appdev/refs/api/krb5_recvauth_version.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_recvauth_version - Server function for sendauth protocol with version parameter. — 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_sendauth - Client function for sendauth protocol." href="krb5_sendauth.html" /> <link rel="prev" title="krb5_recvauth - Server function for sendauth protocol." href="krb5_recvauth.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-recvauth-version-server-function-for-sendauth-protocol-with-version-parameter"> + <section id="krb5-recvauth-version-server-function-for-sendauth-protocol-with-version-parameter"> <h1>krb5_recvauth_version - Server function for sendauth protocol with version parameter.<a class="headerlink" href="#krb5-recvauth-version-server-function-for-sendauth-protocol-with-version-parameter" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_recvauth_version"> -<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_recvauth_version</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> fd</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> flags</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> **<em> ticket</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> version</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_recvauth_version" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_recvauth_version"> +<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_recvauth_version</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">fd</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ticket</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">version</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_recvauth_version" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> <p><strong>[in]</strong> <strong>fd</strong> - File descriptor</p> <p><strong>[in]</strong> <strong>server</strong> - Server principal (NULL for any in <em>keytab</em> )</p> <p><strong>[in]</strong> <strong>flags</strong> - Additional specifications</p> <p><strong>[in]</strong> <strong>keytab</strong> - Decryption key</p> <p><strong>[out]</strong> <strong>ticket</strong> - Ticket (NULL if not needed)</p> -<p class="last"><strong>[out]</strong> <strong>version</strong> - sendauth protocol version (NULL if not needed)</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>version</strong> - sendauth protocol version (NULL if not needed)</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> -<p>This function is similar to <a class="reference internal" href="krb5_recvauth.html#c.krb5_recvauth" title="krb5_recvauth"><code class="xref c c-func docutils literal"><span class="pre">krb5_recvauth()</span></code></a> with the additional output information place into <em>version</em> .</p> -</div> +</dd> +</dl> +<p>This function is similar to krb5_recvauth() with the additional output information place into <em>version</em> .</p> +</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_recvauth_version - Server function for sendauth protocol with version parameter.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_responder_get_challenge.html b/doc/html/appdev/refs/api/krb5_responder_get_challenge.html index 33923e09e4cf..ce371663d72c 100644 --- a/doc/html/appdev/refs/api/krb5_responder_get_challenge.html +++ b/doc/html/appdev/refs/api/krb5_responder_get_challenge.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_responder_get_challenge - Retrieve the challenge data for a given question in the responder context. — 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_responder_list_questions - List the question names contained in the responder context." href="krb5_responder_list_questions.html" /> <link rel="prev" title="krb5_realm_compare - Compare the realms of two principals." href="krb5_realm_compare.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-get-challenge-retrieve-the-challenge-data-for-a-given-question-in-the-responder-context"> + <section id="krb5-responder-get-challenge-retrieve-the-challenge-data-for-a-given-question-in-the-responder-context"> <h1>krb5_responder_get_challenge - Retrieve the challenge data for a given question in the responder context.<a class="headerlink" href="#krb5-responder-get-challenge-retrieve-the-challenge-data-for-a-given-question-in-the-responder-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_get_challenge"> -const char * <code class="descname">krb5_responder_get_challenge</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, const char *<em> question</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_get_challenge" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_get_challenge"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_responder_get_challenge</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">question</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_get_challenge" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -<p class="last"><strong>[in]</strong> <strong>question</strong> - Question name</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>question</strong> - Question name</p> +</dd> +</dl> <p>Return a pointer to a C string containing the challenge for <em>question</em> within <em>rctx</em> , or NULL if the question is not present in <em>rctx</em> . The structure of the question depends on the question name, but will always be printable UTF-8 text. The returned pointer is an alias, valid only as long as the lifetime of <em>rctx</em> , and should not be modified or freed by the caller.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_get_challenge - Retrieve the challenge data for a given question in the responder context.</a></li> @@ -135,6 +124,7 @@ const char * <code class="descname">krb5_responder_get_challenge</code><span cla <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ const char * <code class="descname">krb5_responder_get_challenge</code><span cla <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_responder_list_questions.html b/doc/html/appdev/refs/api/krb5_responder_list_questions.html index 68378087fb6c..a4b4449df412 100644 --- a/doc/html/appdev/refs/api/krb5_responder_list_questions.html +++ b/doc/html/appdev/refs/api/krb5_responder_list_questions.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_responder_list_questions - List the question names contained in the responder context. — 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_responder_set_answer - Answer a named question in the responder context." href="krb5_responder_set_answer.html" /> <link rel="prev" title="krb5_responder_get_challenge - Retrieve the challenge data for a given question in the responder context." href="krb5_responder_get_challenge.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,36 +52,34 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-list-questions-list-the-question-names-contained-in-the-responder-context"> + <section id="krb5-responder-list-questions-list-the-question-names-contained-in-the-responder-context"> <h1>krb5_responder_list_questions - List the question names contained in the responder context.<a class="headerlink" href="#krb5-responder-list-questions-list-the-question-names-contained-in-the-responder-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_list_questions"> -const char *const * <code class="descname">krb5_responder_list_questions</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_list_questions" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_list_questions"> +<span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="sig-name descname"><span class="n"><span class="pre">krb5_responder_list_questions</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_list_questions" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> -<p class="last"><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -</td> -</tr> -</tbody> -</table> -<p>Return a pointer to a null-terminated list of question names which are present in <em>rctx</em> . The pointer is an alias, valid only as long as the lifetime of <em>rctx</em> , and should not be modified or freed by the caller. A question’s challenge can be retrieved using <a class="reference internal" href="krb5_responder_get_challenge.html#c.krb5_responder_get_challenge" title="krb5_responder_get_challenge"><code class="xref c c-func docutils literal"><span class="pre">krb5_responder_get_challenge()</span></code></a> and answered using <a class="reference internal" href="krb5_responder_set_answer.html#c.krb5_responder_set_answer" title="krb5_responder_set_answer"><code class="xref c c-func docutils literal"><span class="pre">krb5_responder_set_answer()</span></code></a> .</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> +<p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> +</dd> +</dl> +<p>Return a pointer to a null-terminated list of question names which are present in <em>rctx</em> . The pointer is an alias, valid only as long as the lifetime of <em>rctx</em> , and should not be modified or freed by the caller. A question’s challenge can be retrieved using krb5_responder_get_challenge() and answered using krb5_responder_set_answer().</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_list_questions - List the question names contained in the responder context.</a></li> @@ -134,6 +123,7 @@ const char *const * <code class="descname">krb5_responder_list_questions</code>< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ const char *const * <code class="descname">krb5_responder_list_questions</code>< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_responder_otp_challenge_free.html b/doc/html/appdev/refs/api/krb5_responder_otp_challenge_free.html index 9ba0b2bb6f3f..ce409406a995 100644 --- a/doc/html/appdev/refs/api/krb5_responder_otp_challenge_free.html +++ b/doc/html/appdev/refs/api/krb5_responder_otp_challenge_free.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" /> - <title>krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() . — 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> + <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_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge(). — MIT Kerberos Documentation</title> + <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_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct." href="krb5_responder_pkinit_get_challenge.html" /> <link rel="prev" title="krb5_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question." href="krb5_responder_otp_set_answer.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge().">feedback</a> </div> </div> </div> @@ -61,39 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-otp-challenge-free-free-the-value-returned-by-krb5-responder-otp-get-challenge"> -<h1>krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() .<a class="headerlink" href="#krb5-responder-otp-challenge-free-free-the-value-returned-by-krb5-responder-otp-get-challenge" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_otp_challenge_free"> -void <code class="descname">krb5_responder_otp_challenge_free</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, <a class="reference internal" href="../types/krb5_responder_otp_challenge.html#c.krb5_responder_otp_challenge" title="krb5_responder_otp_challenge">krb5_responder_otp_challenge</a> *<em> chl</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_challenge_free" title="Permalink to this definition">¶</a></dt> + <section id="krb5-responder-otp-challenge-free-free-the-value-returned-by-krb5-responder-otp-get-challenge"> +<h1>krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge().<a class="headerlink" href="#krb5-responder-otp-challenge-free-free-the-value-returned-by-krb5-responder-otp-get-challenge" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_otp_challenge_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_responder_otp_challenge_free</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <a class="reference internal" href="../types/krb5_responder_otp_challenge.html#c.krb5_responder_otp_challenge" title="krb5_responder_otp_challenge"><span class="n"><span class="pre">krb5_responder_otp_challenge</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">chl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_challenge_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -<p class="last"><strong>[in]</strong> <strong>chl</strong> - The challenge to free</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>chl</strong> - The challenge to free</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() .</a></li> +<li><a class="reference internal" href="#">krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge().</a></li> </ul> <br/> @@ -134,6 +123,7 @@ void <code class="descname">krb5_responder_otp_challenge_free</code><span class= <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ void <code class="descname">krb5_responder_otp_challenge_free</code><span class= <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -156,7 +146,7 @@ void <code class="descname">krb5_responder_otp_challenge_free</code><span class= >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_responder_otp_get_challenge.html b/doc/html/appdev/refs/api/krb5_responder_otp_get_challenge.html index ad3d9483ee5b..6ab6f1ac97a3 100644 --- a/doc/html/appdev/refs/api/krb5_responder_otp_get_challenge.html +++ b/doc/html/appdev/refs/api/krb5_responder_otp_get_challenge.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_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct. — 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_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question." href="krb5_responder_otp_set_answer.html" /> <link rel="prev" title="krb5_responder_set_answer - Answer a named question in the responder context." href="krb5_responder_set_answer.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,38 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-otp-get-challenge-decode-the-krb5-responder-question-otp-to-a-c-struct"> + <section id="krb5-responder-otp-get-challenge-decode-the-krb5-responder-question-otp-to-a-c-struct"> <h1>krb5_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct.<a class="headerlink" href="#krb5-responder-otp-get-challenge-decode-the-krb5-responder-question-otp-to-a-c-struct" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_otp_get_challenge"> -<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_responder_otp_get_challenge</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, <a class="reference internal" href="../types/krb5_responder_otp_challenge.html#c.krb5_responder_otp_challenge" title="krb5_responder_otp_challenge">krb5_responder_otp_challenge</a> **<em> chl</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_get_challenge" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_otp_get_challenge"> +<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_responder_otp_get_challenge</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <a class="reference internal" href="../types/krb5_responder_otp_challenge.html#c.krb5_responder_otp_challenge" title="krb5_responder_otp_challenge"><span class="n"><span class="pre">krb5_responder_otp_challenge</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">chl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_get_challenge" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -<p class="last"><strong>[out]</strong> <strong>chl</strong> - Challenge structure</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>chl</strong> - Challenge structure</p> +</dd> +</dl> <p>A convenience function which parses the KRB5_RESPONDER_QUESTION_OTP question challenge data, making it available in native C. The main feature of this function is the ability to interact with OTP tokens without parsing the JSON.</p> -<p>The returned value must be passed to <a class="reference internal" href="krb5_responder_otp_challenge_free.html#c.krb5_responder_otp_challenge_free" title="krb5_responder_otp_challenge_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_responder_otp_challenge_free()</span></code></a> to be freed.</p> +<p>The returned value must be passed to krb5_responder_otp_challenge_free() to be freed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct.</a></li> @@ -136,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_responder_otp_set_answer.html b/doc/html/appdev/refs/api/krb5_responder_otp_set_answer.html index 092a51b04faa..52b7433c6612 100644 --- a/doc/html/appdev/refs/api/krb5_responder_otp_set_answer.html +++ b/doc/html/appdev/refs/api/krb5_responder_otp_set_answer.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_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question. — 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_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." href="krb5_responder_otp_challenge_free.html" /> + <link rel="next" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." href="krb5_responder_otp_challenge_free.html" /> <link rel="prev" title="krb5_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct." href="krb5_responder_otp_get_challenge.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,7 +33,7 @@ accesskey="C">Contents</a> | <a href="krb5_responder_otp_get_challenge.html" title="krb5_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct." accesskey="P">previous</a> | - <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." + <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,38 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-otp-set-answer-answer-the-krb5-responder-question-otp-question"> + <section id="krb5-responder-otp-set-answer-answer-the-krb5-responder-question-otp-question"> <h1>krb5_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question.<a class="headerlink" href="#krb5-responder-otp-set-answer-answer-the-krb5-responder-question-otp-question" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_otp_set_answer"> -<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_responder_otp_set_answer</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, size_t<em> ti</em>, const char *<em> value</em>, const char *<em> pin</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_set_answer" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_otp_set_answer"> +<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_responder_otp_set_answer</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">ti</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">value</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pin</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_otp_set_answer" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> <p><strong>[in]</strong> <strong>ti</strong> - The index of the tokeninfo selected</p> <p><strong>[in]</strong> <strong>value</strong> - The value to set, or NULL for none</p> -<p class="last"><strong>[in]</strong> <strong>pin</strong> - The pin to set, or NULL for none</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>pin</strong> - The pin to set, or NULL for none</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_otp_set_answer - Answer the KRB5_RESPONDER_QUESTION_OTP question.</a></li> @@ -136,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -152,7 +142,7 @@ >Contents</a> | <a href="krb5_responder_otp_get_challenge.html" title="krb5_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct." >previous</a> | - <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." + <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_responder_pkinit_challenge_free.html b/doc/html/appdev/refs/api/krb5_responder_pkinit_challenge_free.html index c28c3e9db77e..2de5e9a2e3b9 100644 --- a/doc/html/appdev/refs/api/krb5_responder_pkinit_challenge_free.html +++ b/doc/html/appdev/refs/api/krb5_responder_pkinit_challenge_free.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" /> - <title>krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() . — 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> + <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_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge(). — MIT Kerberos Documentation</title> + <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_set_default_realm - Override the default realm for the specified context." href="krb5_set_default_realm.html" /> <link rel="prev" title="krb5_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity." href="krb5_responder_pkinit_set_answer.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -48,7 +39,7 @@ accesskey="I">index</a> | <a href="../../../search.html" title="Enter search criteria" accesskey="S">Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge().">feedback</a> </div> </div> </div> @@ -61,39 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-pkinit-challenge-free-free-the-value-returned-by-krb5-responder-pkinit-get-challenge"> -<h1>krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() .<a class="headerlink" href="#krb5-responder-pkinit-challenge-free-free-the-value-returned-by-krb5-responder-pkinit-get-challenge" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_pkinit_challenge_free"> -void <code class="descname">krb5_responder_pkinit_challenge_free</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, <a class="reference internal" href="../types/krb5_responder_pkinit_challenge.html#c.krb5_responder_pkinit_challenge" title="krb5_responder_pkinit_challenge">krb5_responder_pkinit_challenge</a> *<em> chl</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_challenge_free" title="Permalink to this definition">¶</a></dt> + <section id="krb5-responder-pkinit-challenge-free-free-the-value-returned-by-krb5-responder-pkinit-get-challenge"> +<h1>krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge().<a class="headerlink" href="#krb5-responder-pkinit-challenge-free-free-the-value-returned-by-krb5-responder-pkinit-get-challenge" title="Permalink to this headline">¶</a></h1> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_pkinit_challenge_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_responder_pkinit_challenge_free</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <a class="reference internal" href="../types/krb5_responder_pkinit_challenge.html#c.krb5_responder_pkinit_challenge" title="krb5_responder_pkinit_challenge"><span class="n"><span class="pre">krb5_responder_pkinit_challenge</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">chl</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_challenge_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -<p class="last"><strong>[in]</strong> <strong>chl</strong> - The challenge to free</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>chl</strong> - The challenge to free</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.12</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.12</p> </div> +</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_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() .</a></li> +<li><a class="reference internal" href="#">krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge().</a></li> </ul> <br/> @@ -134,6 +123,7 @@ void <code class="descname">krb5_responder_pkinit_challenge_free</code><span cla <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -141,8 +131,8 @@ void <code class="descname">krb5_responder_pkinit_challenge_free</code><span cla <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -156,7 +146,7 @@ void <code class="descname">krb5_responder_pkinit_challenge_free</code><span cla >index</a> | <a href="../../../search.html" title="Enter search criteria" >Search</a> | - <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() .">feedback</a> + <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge().">feedback</a> </div> </div> </div> diff --git a/doc/html/appdev/refs/api/krb5_responder_pkinit_get_challenge.html b/doc/html/appdev/refs/api/krb5_responder_pkinit_get_challenge.html index efd54e65ea35..04b4a7caa942 100644 --- a/doc/html/appdev/refs/api/krb5_responder_pkinit_get_challenge.html +++ b/doc/html/appdev/refs/api/krb5_responder_pkinit_get_challenge.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_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct. — 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_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity." href="krb5_responder_pkinit_set_answer.html" /> - <link rel="prev" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." href="krb5_responder_otp_challenge_free.html" /> - </head> - <body> + <link rel="prev" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." href="krb5_responder_otp_challenge_free.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." + <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." accesskey="P">previous</a> | <a href="krb5_responder_pkinit_set_answer.html" title="krb5_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity." accesskey="N">next</a> | @@ -61,38 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-pkinit-get-challenge-decode-the-krb5-responder-question-pkinit-to-a-c-struct"> + <section id="krb5-responder-pkinit-get-challenge-decode-the-krb5-responder-question-pkinit-to-a-c-struct"> <h1>krb5_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct.<a class="headerlink" href="#krb5-responder-pkinit-get-challenge-decode-the-krb5-responder-question-pkinit-to-a-c-struct" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_pkinit_get_challenge"> -<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_responder_pkinit_get_challenge</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, <a class="reference internal" href="../types/krb5_responder_pkinit_challenge.html#c.krb5_responder_pkinit_challenge" title="krb5_responder_pkinit_challenge">krb5_responder_pkinit_challenge</a> **<em> chl_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_get_challenge" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_pkinit_get_challenge"> +<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_responder_pkinit_get_challenge</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <a class="reference internal" href="../types/krb5_responder_pkinit_challenge.html#c.krb5_responder_pkinit_challenge" title="krb5_responder_pkinit_challenge"><span class="n"><span class="pre">krb5_responder_pkinit_challenge</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">chl_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_get_challenge" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> -<p class="last"><strong>[out]</strong> <strong>chl_out</strong> - Challenge structure</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>chl_out</strong> - Challenge structure</p> +</dd> +</dl> <p>A convenience function which parses the KRB5_RESPONDER_QUESTION_PKINIT question challenge data, making it available in native C. The main feature of this function is the ability to read the challenge without parsing the JSON.</p> -<p>The returned value must be passed to <a class="reference internal" href="krb5_responder_pkinit_challenge_free.html#c.krb5_responder_pkinit_challenge_free" title="krb5_responder_pkinit_challenge_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_responder_pkinit_challenge_free()</span></code></a> to be freed.</p> +<p>The returned value must be passed to krb5_responder_pkinit_challenge_free() to be freed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.12</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.12</p> </div> +</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_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct.</a></li> @@ -136,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,14 +133,14 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge() ." + <a href="krb5_responder_otp_challenge_free.html" title="krb5_responder_otp_challenge_free - Free the value returned by krb5_responder_otp_get_challenge()." >previous</a> | <a href="krb5_responder_pkinit_set_answer.html" title="krb5_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity." >next</a> | diff --git a/doc/html/appdev/refs/api/krb5_responder_pkinit_set_answer.html b/doc/html/appdev/refs/api/krb5_responder_pkinit_set_answer.html index 23876e0ccd1b..50e905eb94fd 100644 --- a/doc/html/appdev/refs/api/krb5_responder_pkinit_set_answer.html +++ b/doc/html/appdev/refs/api/krb5_responder_pkinit_set_answer.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_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity. — 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_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." href="krb5_responder_pkinit_challenge_free.html" /> + <link rel="next" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." href="krb5_responder_pkinit_challenge_free.html" /> <link rel="prev" title="krb5_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct." href="krb5_responder_pkinit_get_challenge.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -42,7 +33,7 @@ accesskey="C">Contents</a> | <a href="krb5_responder_pkinit_get_challenge.html" title="krb5_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct." accesskey="P">previous</a> | - <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." + <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." accesskey="N">next</a> | <a href="../../../genindex.html" title="General Index" accesskey="I">index</a> | @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-pkinit-set-answer-answer-the-krb5-responder-question-pkinit-question-for-one-identity"> + <section id="krb5-responder-pkinit-set-answer-answer-the-krb5-responder-question-pkinit-question-for-one-identity"> <h1>krb5_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity.<a class="headerlink" href="#krb5-responder-pkinit-set-answer-answer-the-krb5-responder-question-pkinit-question-for-one-identity" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_pkinit_set_answer"> -<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_responder_pkinit_set_answer</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, const char *<em> identity</em>, const char *<em> pin</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_set_answer" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_pkinit_set_answer"> +<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_responder_pkinit_set_answer</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">identity</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pin</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_pkinit_set_answer" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> <p><strong>[in]</strong> <strong>identity</strong> - The identity for which a PIN is being supplied</p> -<p class="last"><strong>[in]</strong> <strong>pin</strong> - The provided PIN, or NULL for none</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>pin</strong> - The provided PIN, or NULL for none</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.12</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.12</p> </div> +</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_responder_pkinit_set_answer - Answer the KRB5_RESPONDER_QUESTION_PKINIT question for one identity.</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> @@ -151,7 +141,7 @@ >Contents</a> | <a href="krb5_responder_pkinit_get_challenge.html" title="krb5_responder_pkinit_get_challenge - Decode the KRB5_RESPONDER_QUESTION_PKINIT to a C struct." >previous</a> | - <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." + <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." >next</a> | <a href="../../../genindex.html" title="General Index" >index</a> | diff --git a/doc/html/appdev/refs/api/krb5_responder_set_answer.html b/doc/html/appdev/refs/api/krb5_responder_set_answer.html index 9909be10e821..eebea59e580b 100644 --- a/doc/html/appdev/refs/api/krb5_responder_set_answer.html +++ b/doc/html/appdev/refs/api/krb5_responder_set_answer.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_responder_set_answer - Answer a named question in the responder context. — 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_responder_otp_get_challenge - Decode the KRB5_RESPONDER_QUESTION_OTP to a C struct." href="krb5_responder_otp_get_challenge.html" /> <link rel="prev" title="krb5_responder_list_questions - List the question names contained in the responder context." href="krb5_responder_list_questions.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-responder-set-answer-answer-a-named-question-in-the-responder-context"> + <section id="krb5-responder-set-answer-answer-a-named-question-in-the-responder-context"> <h1>krb5_responder_set_answer - Answer a named question in the responder context.<a class="headerlink" href="#krb5-responder-set-answer-answer-a-named-question-in-the-responder-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_responder_set_answer"> -<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_responder_set_answer</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> ctx</em>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context">krb5_responder_context</a><em> rctx</em>, const char *<em> question</em>, const char *<em> answer</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_set_answer" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_responder_set_answer"> +<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_responder_set_answer</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">ctx</span></span>, <a class="reference internal" href="../types/krb5_responder_context.html#c.krb5_responder_context" title="krb5_responder_context"><span class="n"><span class="pre">krb5_responder_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">rctx</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">question</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">answer</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_responder_set_answer" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>rctx</strong> - Responder context</p> <p><strong>[in]</strong> <strong>question</strong> - Question name</p> -<p class="last"><strong>[in]</strong> <strong>answer</strong> - The string to set (MUST be printable UTF-8)</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>EINVAL question is not present within rctx</li> +<p><strong>[in]</strong> <strong>answer</strong> - The string to set (MUST be printable UTF-8)</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>EINVAL question is not present within rctx</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function supplies an answer to <em>question</em> within <em>rctx</em> . The appropriate form of the answer depends on the question name.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.11</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.11</p> </div> +</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_responder_set_answer - Answer a named question in the responder context.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_salttype_to_string.html b/doc/html/appdev/refs/api/krb5_salttype_to_string.html index 81f4dae16f11..ad9d90d1a967 100644 --- a/doc/html/appdev/refs/api/krb5_salttype_to_string.html +++ b/doc/html/appdev/refs/api/krb5_salttype_to_string.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_salttype_to_string - Convert a salt type to a string. — 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_server_decrypt_ticket_keytab - Decrypt a ticket using the specified key table." href="krb5_server_decrypt_ticket_keytab.html" /> <link rel="prev" title="krb5_read_password - Read a password from keyboard input." href="krb5_read_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,43 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-salttype-to-string-convert-a-salt-type-to-a-string"> + <section id="krb5-salttype-to-string-convert-a-salt-type-to-a-string"> <h1>krb5_salttype_to_string - Convert a salt type to a string.<a class="headerlink" href="#krb5-salttype-to-string-convert-a-salt-type-to-a-string" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_salttype_to_string"> -<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_salttype_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> salttype</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_salttype_to_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_salttype_to_string"> +<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_salttype_to_string</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">salttype</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_salttype_to_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>salttype</strong> - Salttype to convert</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>salttype</strong> - Salttype to convert</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to receive the converted string</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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> -</div> +</dd> +</dl> +</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_salttype_to_string - Convert a salt type to a string.</a></li> @@ -141,6 +126,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -148,8 +134,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_sendauth.html b/doc/html/appdev/refs/api/krb5_sendauth.html index 9d4a6fca4a46..cdf295e6c539 100644 --- a/doc/html/appdev/refs/api/krb5_sendauth.html +++ b/doc/html/appdev/refs/api/krb5_sendauth.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_sendauth - Client function for sendauth protocol. — 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_524_convert_creds - Convert a Kerberos V5 credentials to a Kerberos V4 credentials." href="krb5_524_convert_creds.html" /> <link rel="prev" title="krb5_recvauth_version - Server function for sendauth protocol with version parameter." href="krb5_recvauth_version.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,70 +52,64 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-sendauth-client-function-for-sendauth-protocol"> + <section id="krb5-sendauth-client-function-for-sendauth-protocol"> <h1>krb5_sendauth - Client function for sendauth protocol.<a class="headerlink" href="#krb5-sendauth-client-function-for-sendauth-protocol" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_sendauth"> -<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_sendauth</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context">krb5_auth_context</a> *<em> auth_context</em>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer">krb5_pointer</a><em> fd</em>, char *<em> appl_version</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> client</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> ap_req_options</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in_data</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> in_creds</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error">krb5_error</a> **<em> error</em>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part">krb5_ap_rep_enc_part</a> **<em> rep_result</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> out_creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sendauth" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_sendauth"> +<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_sendauth</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>, <a class="reference internal" href="../types/krb5_auth_context.html#c.krb5_auth_context" title="krb5_auth_context"><span class="n"><span class="pre">krb5_auth_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">auth_context</span></span>, <a class="reference internal" href="../types/krb5_pointer.html#c.krb5_pointer" title="krb5_pointer"><span class="n"><span class="pre">krb5_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">fd</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">appl_version</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">client</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">ap_req_options</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">in_data</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">in_creds</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_error.html#c.krb5_error" title="krb5_error"><span class="n"><span class="pre">krb5_error</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">error</span></span>, <a class="reference internal" href="../types/krb5_ap_rep_enc_part.html#c.krb5_ap_rep_enc_part" title="krb5_ap_rep_enc_part"><span class="n"><span class="pre">krb5_ap_rep_enc_part</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">rep_result</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">out_creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sendauth" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[inout]</strong> <strong>auth_context</strong> - Pre-existing or newly created auth context</p> <p><strong>[in]</strong> <strong>fd</strong> - File descriptor that describes network socket</p> <p><strong>[in]</strong> <strong>appl_version</strong> - Application protocol version to be matched with the receiver’s application version</p> <p><strong>[in]</strong> <strong>client</strong> - Client principal</p> <p><strong>[in]</strong> <strong>server</strong> - Server principal</p> -<p><strong>[in]</strong> <strong>ap_req_options</strong> - <code class="xref py py-data docutils literal"><span class="pre">AP_OPTS</span></code> options</p> +<p><strong>[in]</strong> <strong>ap_req_options</strong> - Options (see AP_OPTS macros)</p> <p><strong>[in]</strong> <strong>in_data</strong> - Data to be sent to the server</p> <p><strong>[in]</strong> <strong>in_creds</strong> - Input credentials, or NULL to use <em>ccache</em></p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache</p> <p><strong>[out]</strong> <strong>error</strong> - If non-null, contains KRB_ERROR message returned from server</p> -<p><strong>[out]</strong> <strong>rep_result</strong> - If non-null and <em>ap_req_options</em> is <a class="reference internal" href="../macros/AP_OPTS_MUTUAL_REQUIRED.html#AP_OPTS_MUTUAL_REQUIRED" title="AP_OPTS_MUTUAL_REQUIRED"><code class="xref py py-data docutils literal"><span class="pre">AP_OPTS_MUTUAL_REQUIRED</span></code></a> , contains the result of mutual authentication exchange</p> -<p class="last"><strong>[out]</strong> <strong>out_creds</strong> - If non-null, the retrieved credentials</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>rep_result</strong> - If non-null and <em>ap_req_options</em> is #AP_OPTS_MUTUAL_REQUIRED, contains the result of mutual authentication exchange</p> +<p><strong>[out]</strong> <strong>out_creds</strong> - If non-null, the retrieved credentials</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 performs the client side of a sendauth/recvauth exchange by sending and receiving messages over <em>fd</em> .</p> <p>Credentials may be specified in three ways:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li>If <em>in_creds</em> is NULL, credentials are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> using the principals <em>client</em> and <em>server</em> . <em>server</em> must be non-null; <em>client</em> may NULL to use the default principal of <em>ccache</em> .</li> -<li>If <em>in_creds</em> is non-null, but does not contain a ticket, credentials for the exchange are obtained with <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> using <em>in_creds</em> . In this case, the values of <em>client</em> and <em>server</em> are unused.</li> -<li>If <em>in_creds</em> is a complete credentials structure, it used directly. In this case, the values of <em>client</em> , <em>server</em> , and <em>ccache</em> are unused.</li> +<li><p>If <em>in_creds</em> is NULL, credentials are obtained with krb5_get_credentials() using the principals <em>client</em> and <em>server</em> . <em>server</em> must be non-null; <em>client</em> may NULL to use the default principal of <em>ccache</em> .</p></li> +<li><p>If <em>in_creds</em> is non-null, but does not contain a ticket, credentials for the exchange are obtained with krb5_get_credentials() using <em>in_creds</em> . In this case, the values of <em>client</em> and <em>server</em> are unused.</p></li> +<li><p>If <em>in_creds</em> is a complete credentials structure, it used directly. In this case, the values of <em>client</em> , <em>server</em> , and <em>ccache</em> are unused.</p></li> </ul> </div></blockquote> <p>If the server is using a different application protocol than that specified in <em>appl_version</em> , an error will be returned.</p> </div></blockquote> -<p>Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></code></a> to free <em>out_creds</em> , <a class="reference internal" href="krb5_free_ap_rep_enc_part.html#c.krb5_free_ap_rep_enc_part" title="krb5_free_ap_rep_enc_part"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_ap_rep_enc_part()</span></code></a> to free <em>rep_result</em> , and <a class="reference internal" href="krb5_free_error.html#c.krb5_free_error" title="krb5_free_error"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_error()</span></code></a> to free <em>error</em> when they are no longer needed.</p> +<p>Use krb5_free_creds() to free <em>out_creds</em> , krb5_free_ap_rep_enc_part() to free <em>rep_result</em> , and krb5_free_error() to free <em>error</em> when they are no longer needed.</p> <div class="admonition seealso"> -<p class="first admonition-title">See also</p> -<p class="last"><a class="reference internal" href="krb5_recvauth.html#c.krb5_recvauth" title="krb5_recvauth"><code class="xref c c-func docutils literal"><span class="pre">krb5_recvauth()</span></code></a></p> -</div> +<p class="admonition-title">See also</p> +<p>krb5_recvauth()</p> </div> +</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_sendauth - Client function for sendauth protocol.</a></li> @@ -168,6 +153,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -175,8 +161,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_server_decrypt_ticket_keytab.html b/doc/html/appdev/refs/api/krb5_server_decrypt_ticket_keytab.html index de64b87fc08d..119bad0250bc 100644 --- a/doc/html/appdev/refs/api/krb5_server_decrypt_ticket_keytab.html +++ b/doc/html/appdev/refs/api/krb5_server_decrypt_ticket_keytab.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_server_decrypt_ticket_keytab - Decrypt a ticket using the specified key table. — 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_set_default_tgs_enctypes - Set default TGS encryption types in a krb5_context structure." href="krb5_set_default_tgs_enctypes.html" /> <link rel="prev" title="krb5_salttype_to_string - Convert a salt type to a string." href="krb5_salttype_to_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-server-decrypt-ticket-keytab-decrypt-a-ticket-using-the-specified-key-table"> + <section id="krb5-server-decrypt-ticket-keytab-decrypt-a-ticket-using-the-specified-key-table"> <h1>krb5_server_decrypt_ticket_keytab - Decrypt a ticket using the specified key table.<a class="headerlink" href="#krb5-server-decrypt-ticket-keytab-decrypt-a-ticket-using-the-specified-key-table" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_server_decrypt_ticket_keytab"> -<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_server_decrypt_ticket_keytab</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_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> kt</em>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket">krb5_ticket</a> *<em> ticket</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_server_decrypt_ticket_keytab" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_server_decrypt_ticket_keytab"> +<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_server_decrypt_ticket_keytab</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_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">kt</span></span>, <a class="reference internal" href="../types/krb5_ticket.html#c.krb5_ticket" title="krb5_ticket"><span class="n"><span class="pre">krb5_ticket</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ticket</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_server_decrypt_ticket_keytab" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>kt</strong> - Key table</p> -<p class="last"><strong>[in]</strong> <strong>ticket</strong> - Ticket to be decrypted</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>ticket</strong> - Ticket to be decrypted</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 takes a <em>ticket</em> as input and decrypts it using key data from <em>kt</em> . The result is placed into <em>ticket->enc_part2</em> .</p> -</div> +</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_server_decrypt_ticket_keytab - Decrypt a ticket using the specified key table.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_default_realm.html b/doc/html/appdev/refs/api/krb5_set_default_realm.html index e9a1b259fd45..a8fb3c4cb3a5 100644 --- a/doc/html/appdev/refs/api/krb5_set_default_realm.html +++ b/doc/html/appdev/refs/api/krb5_set_default_realm.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_set_default_realm - Override the default realm for the specified context. — 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_set_password - Set a password for a principal using specified credentials." href="krb5_set_password.html" /> - <link rel="prev" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." href="krb5_responder_pkinit_challenge_free.html" /> - </head> - <body> + <link rel="prev" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." href="krb5_responder_pkinit_challenge_free.html" /> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -40,7 +31,7 @@ <a href="../../../index.html" title="Full Table of Contents" accesskey="C">Contents</a> | - <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." + <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." accesskey="P">previous</a> | <a href="krb5_set_password.html" title="krb5_set_password - Set a password for a principal using specified credentials." accesskey="N">next</a> | @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-default-realm-override-the-default-realm-for-the-specified-context"> + <section id="krb5-set-default-realm-override-the-default-realm-for-the-specified-context"> <h1>krb5_set_default_realm - Override the default realm for the specified context.<a class="headerlink" href="#krb5-set-default-realm-override-the-default-realm-for-the-specified-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_default_realm"> -<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_set_default_realm</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 char *<em> lrealm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_default_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_default_realm"> +<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_set_default_realm</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">lrealm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_default_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>lrealm</strong> - Realm name for the default realm</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 simple"> -<li>0 Success</li> +<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>lrealm</strong> - Realm name for the default realm</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>If <em>lrealm</em> is NULL, clear the default realm setting.</p> -</div> +</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_set_default_realm - Override the default realm for the specified context.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,14 +139,14 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> <a href="../../../index.html" title="Full Table of Contents" >Contents</a> | - <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge() ." + <a href="krb5_responder_pkinit_challenge_free.html" title="krb5_responder_pkinit_challenge_free - Free the value returned by krb5_responder_pkinit_get_challenge()." >previous</a> | <a href="krb5_set_password.html" title="krb5_set_password - Set a password for a principal using specified credentials." >next</a> | diff --git a/doc/html/appdev/refs/api/krb5_set_default_tgs_enctypes.html b/doc/html/appdev/refs/api/krb5_set_default_tgs_enctypes.html index a3f5d5b3265a..16d311c4a476 100644 --- a/doc/html/appdev/refs/api/krb5_set_default_tgs_enctypes.html +++ b/doc/html/appdev/refs/api/krb5_set_default_tgs_enctypes.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_set_default_tgs_enctypes - Set default TGS encryption types in a krb5_context structure. — 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_set_error_message - Set an extended error message for an error code." href="krb5_set_error_message.html" /> <link rel="prev" title="krb5_server_decrypt_ticket_keytab - Decrypt a ticket using the specified key table." href="krb5_server_decrypt_ticket_keytab.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-default-tgs-enctypes-set-default-tgs-encryption-types-in-a-krb5-context-structure"> + <section id="krb5-set-default-tgs-enctypes-set-default-tgs-encryption-types-in-a-krb5-context-structure"> <h1>krb5_set_default_tgs_enctypes - Set default TGS encryption types in a krb5_context structure.<a class="headerlink" href="#krb5-set-default-tgs-enctypes-set-default-tgs-encryption-types-in-a-krb5-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_default_tgs_enctypes"> -<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_set_default_tgs_enctypes</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_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> etypes</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_default_tgs_enctypes" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_default_tgs_enctypes"> +<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_set_default_tgs_enctypes</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_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">etypes</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_default_tgs_enctypes" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>etypes</strong> - Encryption type(s) to set</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 simple"> -<li>0 Success</li> -<li>KRB5_PROG_ETYPE_NOSUPP Program lacks support for encryption type</li> +<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>etypes</strong> - Encryption type(s) to set</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</p></li> +<li><p>KRB5_PROG_ETYPE_NOSUPP Program lacks support for encryption type</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function sets the default enctype list for TGS requests made using <em>context</em> to <em>etypes</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This overrides the default list (from config file or built-in).</p> -</div> +<p class="admonition-title">Note</p> +<p>This overrides the default list (from config file or built-in).</p> </div> +</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_set_default_tgs_enctypes - Set default TGS encryption types in a krb5_context structure.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_error_message.html b/doc/html/appdev/refs/api/krb5_set_error_message.html index 7af404228e89..95d6cab50cbe 100644 --- a/doc/html/appdev/refs/api/krb5_set_error_message.html +++ b/doc/html/appdev/refs/api/krb5_set_error_message.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_set_error_message - Set an extended error message for an error code. — 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_set_kdc_recv_hook - Set a KDC post-receive hook function." href="krb5_set_kdc_recv_hook.html" /> <link rel="prev" title="krb5_set_default_tgs_enctypes - Set default TGS encryption types in a krb5_context structure." href="krb5_set_default_tgs_enctypes.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,32 +52,30 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-error-message-set-an-extended-error-message-for-an-error-code"> + <section id="krb5-set-error-message-set-an-extended-error-message-for-an-error-code"> <h1>krb5_set_error_message - Set an extended error message for an error code.<a class="headerlink" href="#krb5-set-error-message-set-an-extended-error-message-for-an-error-code" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_error_message"> -void <code class="descname">krb5_set_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_set_error_message</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">ctx</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> -<p class="last"><strong>[in]</strong> <strong>fmt</strong> - Error string for the error code</p> -</td> -</tr> -</tbody> -</table> -</div> +<p><strong>[in]</strong> <strong>fmt</strong> - Error string for the error code</p> +</dd> +</dl> +</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_set_error_message - Set an extended error message for an error code.</a></li> @@ -130,6 +119,7 @@ void <code class="descname">krb5_set_error_message</code><span class="sig-paren" <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -137,8 +127,8 @@ void <code class="descname">krb5_set_error_message</code><span class="sig-paren" <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_kdc_recv_hook.html b/doc/html/appdev/refs/api/krb5_set_kdc_recv_hook.html index 0a79228040df..b26d79d566f0 100644 --- a/doc/html/appdev/refs/api/krb5_set_kdc_recv_hook.html +++ b/doc/html/appdev/refs/api/krb5_set_kdc_recv_hook.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_set_kdc_recv_hook - Set a KDC post-receive hook function. — 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_set_kdc_send_hook - Set a KDC pre-send hook function." href="krb5_set_kdc_send_hook.html" /> <link rel="prev" title="krb5_set_error_message - Set an extended error message for an error code." href="krb5_set_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,38 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-kdc-recv-hook-set-a-kdc-post-receive-hook-function"> + <section id="krb5-set-kdc-recv-hook-set-a-kdc-post-receive-hook-function"> <h1>krb5_set_kdc_recv_hook - Set a KDC post-receive hook function.<a class="headerlink" href="#krb5-set-kdc-recv-hook-set-a-kdc-post-receive-hook-function" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_kdc_recv_hook"> -void <code class="descname">krb5_set_kdc_recv_hook</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>, <a class="reference internal" href="../types/krb5_post_recv_fn.html#c.krb5_post_recv_fn" title="krb5_post_recv_fn">krb5_post_recv_fn</a><em> recv_hook</em>, void *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_kdc_recv_hook" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_kdc_recv_hook"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_set_kdc_recv_hook</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>, <a class="reference internal" href="../types/krb5_post_recv_fn.html#c.krb5_post_recv_fn" title="krb5_post_recv_fn"><span class="n"><span class="pre">krb5_post_recv_fn</span></span></a><span class="w"> </span><span class="n"><span class="pre">recv_hook</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_kdc_recv_hook" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - The library context.</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>context</strong> - The library context.</p> <p><strong>[in]</strong> <strong>recv_hook</strong> - Hook function (or NULL to disable the hook)</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Callback data to be passed to <em>recv_hook</em></p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>data</strong> - Callback data to be passed to <em>recv_hook</em></p> +</dd> +</dl> <blockquote> -<div><em>recv_hook</em> will be called after a reply is received from a KDC during a call to a library function such as <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> . The hook function may inspect or override the reply. This hook will not be executed if the pre-send hook returns a synthetic reply.</div></blockquote> +<div><p><em>recv_hook</em> will be called after a reply is received from a KDC during a call to a library function such as krb5_get_credentials(). The hook function may inspect or override the reply. This hook will not be executed if the pre-send hook returns a synthetic reply.</p> +</div></blockquote> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.15</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.15</p> </div> +</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_set_kdc_recv_hook - Set a KDC post-receive hook function.</a></li> @@ -136,6 +126,7 @@ void <code class="descname">krb5_set_kdc_recv_hook</code><span class="sig-paren" <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +134,8 @@ void <code class="descname">krb5_set_kdc_recv_hook</code><span class="sig-paren" <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_kdc_send_hook.html b/doc/html/appdev/refs/api/krb5_set_kdc_send_hook.html index 9268535b4354..7d6179650509 100644 --- a/doc/html/appdev/refs/api/krb5_set_kdc_send_hook.html +++ b/doc/html/appdev/refs/api/krb5_set_kdc_send_hook.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_set_kdc_send_hook - Set a KDC pre-send hook function. — 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_set_real_time - Set time offset field in a krb5_context structure." href="krb5_set_real_time.html" /> <link rel="prev" title="krb5_set_kdc_recv_hook - Set a KDC post-receive hook function." href="krb5_set_kdc_recv_hook.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,38 +52,37 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-kdc-send-hook-set-a-kdc-pre-send-hook-function"> + <section id="krb5-set-kdc-send-hook-set-a-kdc-pre-send-hook-function"> <h1>krb5_set_kdc_send_hook - Set a KDC pre-send hook function.<a class="headerlink" href="#krb5-set-kdc-send-hook-set-a-kdc-pre-send-hook-function" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_kdc_send_hook"> -void <code class="descname">krb5_set_kdc_send_hook</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>, <a class="reference internal" href="../types/krb5_pre_send_fn.html#c.krb5_pre_send_fn" title="krb5_pre_send_fn">krb5_pre_send_fn</a><em> send_hook</em>, void *<em> data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_kdc_send_hook" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_kdc_send_hook"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_set_kdc_send_hook</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>, <a class="reference internal" href="../types/krb5_pre_send_fn.html#c.krb5_pre_send_fn" title="krb5_pre_send_fn"><span class="n"><span class="pre">krb5_pre_send_fn</span></span></a><span class="w"> </span><span class="n"><span class="pre">send_hook</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_kdc_send_hook" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>send_hook</strong> - Hook function (or NULL to disable the hook)</p> -<p class="last"><strong>[in]</strong> <strong>data</strong> - Callback data to be passed to <em>send_hook</em></p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>data</strong> - Callback data to be passed to <em>send_hook</em></p> +</dd> +</dl> <blockquote> -<div><em>send_hook</em> will be called before messages are sent to KDCs by library functions such as <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> . The hook function may inspect, override, or synthesize its own reply to the message.</div></blockquote> +<div><p><em>send_hook</em> will be called before messages are sent to KDCs by library functions such as krb5_get_credentials(). The hook function may inspect, override, or synthesize its own reply to the message.</p> +</div></blockquote> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.15</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.15</p> </div> +</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_set_kdc_send_hook - Set a KDC pre-send hook function.</a></li> @@ -136,6 +126,7 @@ void <code class="descname">krb5_set_kdc_send_hook</code><span class="sig-paren" <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -143,8 +134,8 @@ void <code class="descname">krb5_set_kdc_send_hook</code><span class="sig-paren" <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_password.html b/doc/html/appdev/refs/api/krb5_set_password.html index 3c2d03d83901..322450d82f5e 100644 --- a/doc/html/appdev/refs/api/krb5_set_password.html +++ b/doc/html/appdev/refs/api/krb5_set_password.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_set_password - Set a password for a principal using specified credentials. — 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_set_password_using_ccache - Set a password for a principal using cached credentials." href="krb5_set_password_using_ccache.html" /> <link rel="prev" title="krb5_set_default_realm - Override the default realm for the specified context." href="krb5_set_default_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,58 +52,52 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-password-set-a-password-for-a-principal-using-specified-credentials"> + <section id="krb5-set-password-set-a-password-for-a-principal-using-specified-credentials"> <h1>krb5_set_password - Set a password for a principal using specified credentials.<a class="headerlink" href="#krb5-set-password-set-a-password-for-a-principal-using-specified-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_password"> -<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_set_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, const char *<em> newpw</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> change_password_for</em>, int *<em> result_code</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_code_string</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_string</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_password" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_password"> +<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_set_password</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newpw</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">change_password_for</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result_code</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">result_code_string</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">result_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_password" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>creds</strong> - Credentials for kadmin/changepw service</p> <p><strong>[in]</strong> <strong>newpw</strong> - New password</p> <p><strong>[in]</strong> <strong>change_password_for</strong> - Change the password for this principal</p> <p><strong>[out]</strong> <strong>result_code</strong> - Numeric error code from server</p> <p><strong>[out]</strong> <strong>result_code_string</strong> - String equivalent to <em>result_code</em></p> -<p class="last"><strong>[out]</strong> <strong>result_string</strong> - Data returned from the remote system</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 simple"> -<li>0 Success and result_code is set to KRB5_KPASSWD_SUCCESS .</li> +<p><strong>[out]</strong> <strong>result_string</strong> - Data returned from the remote system</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 and result_code is set to #KRB5_KPASSWD_SUCCESS.</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes.</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function uses the credentials <em>creds</em> to set the password <em>newpw</em> for the principal <em>change_password_for</em> . It implements the set password operation of RFC 3244, for interoperability with Microsoft Windows implementations.</p> <p>The error code and strings are returned in <em>result_code</em> , <em>result_code_string</em> and <em>result_string</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If <em>change_password_for</em> is NULL, the change is performed on the current principal. If <em>change_password_for</em> is non-null, the change is performed on the principal name passed in <em>change_password_for</em> .</p> -</div> +<p class="admonition-title">Note</p> +<p>If <em>change_password_for</em> is NULL, the change is performed on the current principal. If <em>change_password_for</em> is non-null, the change is performed on the principal name passed in <em>change_password_for</em> .</p> </div> +</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_set_password - Set a password for a principal using specified credentials.</a></li> @@ -156,6 +141,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -163,8 +149,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_password_using_ccache.html b/doc/html/appdev/refs/api/krb5_set_password_using_ccache.html index 4f734160aa5c..58450ef5d65f 100644 --- a/doc/html/appdev/refs/api/krb5_set_password_using_ccache.html +++ b/doc/html/appdev/refs/api/krb5_set_password_using_ccache.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_set_password_using_ccache - Set a password for a principal using cached credentials. — 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_set_principal_realm - Set the realm field of a principal." href="krb5_set_principal_realm.html" /> <link rel="prev" title="krb5_set_password - Set a password for a principal using specified credentials." href="krb5_set_password.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,58 +52,52 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-password-using-ccache-set-a-password-for-a-principal-using-cached-credentials"> + <section id="krb5-set-password-using-ccache-set-a-password-for-a-principal-using-cached-credentials"> <h1>krb5_set_password_using_ccache - Set a password for a principal using cached credentials.<a class="headerlink" href="#krb5-set-password-using-ccache-set-a-password-for-a-principal-using-cached-credentials" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_password_using_ccache"> -<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_set_password_using_ccache</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, const char *<em> newpw</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> change_password_for</em>, int *<em> result_code</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_code_string</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> result_string</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_password_using_ccache" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_password_using_ccache"> +<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_set_password_using_ccache</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">newpw</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">change_password_for</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">result_code</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">result_code_string</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">result_string</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_password_using_ccache" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ccache</strong> - Credential cache</p> <p><strong>[in]</strong> <strong>newpw</strong> - New password</p> <p><strong>[in]</strong> <strong>change_password_for</strong> - Change the password for this principal</p> <p><strong>[out]</strong> <strong>result_code</strong> - Numeric error code from server</p> <p><strong>[out]</strong> <strong>result_code_string</strong> - String equivalent to <em>result_code</em></p> -<p class="last"><strong>[out]</strong> <strong>result_string</strong> - Data returned from the remote system</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>result_string</strong> - Data returned from the remote system</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function uses the cached credentials from <em>ccache</em> to set the password <em>newpw</em> for the principal <em>change_password_for</em> . It implements RFC 3244 set password operation (interoperable with MS Windows implementations) using the credential cache.</p> <p>The error code and strings are returned in <em>result_code</em> , <em>result_code_string</em> and <em>result_string</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">If <em>change_password_for</em> is set to NULL, the change is performed on the default principal in <em>ccache</em> . If <em>change_password_for</em> is non null, the change is performed on the specified principal.</p> -</div> +<p class="admonition-title">Note</p> +<p>If <em>change_password_for</em> is set to NULL, the change is performed on the default principal in <em>ccache</em> . If <em>change_password_for</em> is non null, the change is performed on the specified principal.</p> </div> +</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_set_password_using_ccache - Set a password for a principal using cached credentials.</a></li> @@ -156,6 +141,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -163,8 +149,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_principal_realm.html b/doc/html/appdev/refs/api/krb5_set_principal_realm.html index a72b04a81fab..b50b287de6cd 100644 --- a/doc/html/appdev/refs/api/krb5_set_principal_realm.html +++ b/doc/html/appdev/refs/api/krb5_set_principal_realm.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_set_principal_realm - Set the realm field of a principal. — 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_set_trace_callback - Specify a callback function for trace events." href="krb5_set_trace_callback.html" /> <link rel="prev" title="krb5_set_password_using_ccache - Set a password for a principal using cached credentials." href="krb5_set_password_using_ccache.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-principal-realm-set-the-realm-field-of-a-principal"> + <section id="krb5-set-principal-realm-set-the-realm-field-of-a-principal"> <h1>krb5_set_principal_realm - Set the realm field of a principal.<a class="headerlink" href="#krb5-set-principal-realm-set-the-realm-field-of-a-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_principal_realm"> -<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_set_principal_realm</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> principal</em>, const char *<em> realm</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_principal_realm" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_principal_realm"> +<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_set_principal_realm</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>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">realm</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_principal_realm" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal name</p> -<p class="last"><strong>[in]</strong> <strong>realm</strong> - Realm name</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 simple"> -<li>0 Success</li> +<p><strong>[in]</strong> <strong>realm</strong> - Realm name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Set the realm name part of <em>principal</em> to <em>realm</em> , overwriting the previous realm.</p> -</div> +</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_set_principal_realm - Set the realm field of a principal.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_real_time.html b/doc/html/appdev/refs/api/krb5_set_real_time.html index 4b18f441ef88..2786085be63e 100644 --- a/doc/html/appdev/refs/api/krb5_set_real_time.html +++ b/doc/html/appdev/refs/api/krb5_set_real_time.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_set_real_time - Set time offset field in a krb5_context structure. — 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_string_to_cksumtype - Convert a string to a checksum type." href="krb5_string_to_cksumtype.html" /> <link rel="prev" title="krb5_set_kdc_send_hook - Set a KDC pre-send hook function." href="krb5_set_kdc_send_hook.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-real-time-set-time-offset-field-in-a-krb5-context-structure"> + <section id="krb5-set-real-time-set-time-offset-field-in-a-krb5-context-structure"> <h1>krb5_set_real_time - Set time offset field in a krb5_context structure.<a class="headerlink" href="#krb5-set-real-time-set-time-offset-field-in-a-krb5-context-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_real_time"> -<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_set_real_time</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> seconds</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> microseconds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_real_time" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_real_time"> +<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_set_real_time</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">seconds</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">microseconds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_real_time" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>seconds</strong> - Real time, seconds portion</p> -<p class="last"><strong>[in]</strong> <strong>microseconds</strong> - Real time, microseconds portion</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>microseconds</strong> - Real time, microseconds portion</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 sets the time offset in <em>context</em> to the difference between the system time and the real time as determined by <em>seconds</em> and <em>microseconds</em> .</p> -</div> +</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_set_real_time - Set time offset field in a krb5_context structure.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_trace_callback.html b/doc/html/appdev/refs/api/krb5_set_trace_callback.html index 689f7288d7f6..d307a72906ad 100644 --- a/doc/html/appdev/refs/api/krb5_set_trace_callback.html +++ b/doc/html/appdev/refs/api/krb5_set_trace_callback.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_set_trace_callback - Specify a callback function for trace events. — 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_set_trace_filename - Specify a file name for directing trace events." href="krb5_set_trace_filename.html" /> <link rel="prev" title="krb5_set_principal_realm - Set the realm field of a principal." href="krb5_set_principal_realm.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-trace-callback-specify-a-callback-function-for-trace-events"> + <section id="krb5-set-trace-callback-specify-a-callback-function-for-trace-events"> <h1>krb5_set_trace_callback - Specify a callback function for trace events.<a class="headerlink" href="#krb5-set-trace-callback-specify-a-callback-function-for-trace-events" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_trace_callback"> -<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_set_trace_callback</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>, <a class="reference internal" href="../types/krb5_trace_callback.html#c.krb5_trace_callback" title="krb5_trace_callback">krb5_trace_callback</a><em> fn</em>, void *<em> cb_data</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_trace_callback" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_trace_callback"> +<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_set_trace_callback</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>, <a class="reference internal" href="../types/krb5_trace_callback.html#c.krb5_trace_callback" title="krb5_trace_callback"><span class="n"><span class="pre">krb5_trace_callback</span></span></a><span class="w"> </span><span class="n"><span class="pre">fn</span></span>, <span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cb_data</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_trace_callback" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>fn</strong> - Callback function</p> -<p class="last"><strong>[in]</strong> <strong>cb_data</strong> - Callback 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">return:</th><td class="field-body"><ul class="first last simple"> -<li>Returns KRB5_TRACE_NOSUPP if tracing is not supported in the library (unless fn is NULL).</li> +<p><strong>[in]</strong> <strong>cb_data</strong> - Callback data</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>Returns KRB5_TRACE_NOSUPP if tracing is not supported in the library (unless fn is NULL).</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Specify a callback for trace events occurring in krb5 operations performed within <em>context</em> . <em>fn</em> will be invoked with <em>context</em> as the first argument, <em>cb_data</em> as the last argument, and a pointer to a krb5_trace_info as the second argument. If the trace callback is reset via this function or <em>context</em> is destroyed, <em>fn</em> will be invoked with a NULL second argument so it can clean up <em>cb_data</em> . Supply a NULL value for <em>fn</em> to disable trace callbacks within <em>context</em> .</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function overrides the information passed through the <em>KRB5_TRACE</em> environment variable.</p> +<p class="admonition-title">Note</p> +<p>This function overrides the information passed through the <em>KRB5_TRACE</em> environment variable.</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_set_trace_callback - Specify a callback function for trace events.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_set_trace_filename.html b/doc/html/appdev/refs/api/krb5_set_trace_filename.html index 44cb7c32acd4..b3cb27ed1c2c 100644 --- a/doc/html/appdev/refs/api/krb5_set_trace_filename.html +++ b/doc/html/appdev/refs/api/krb5_set_trace_filename.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_set_trace_filename - Specify a file name for directing trace events. — 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_sname_match - Test whether a principal matches a matching principal." href="krb5_sname_match.html" /> <link rel="prev" title="krb5_set_trace_callback - Specify a callback function for trace events." href="krb5_set_trace_callback.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-set-trace-filename-specify-a-file-name-for-directing-trace-events"> + <section id="krb5-set-trace-filename-specify-a-file-name-for-directing-trace-events"> <h1>krb5_set_trace_filename - Specify a file name for directing trace events.<a class="headerlink" href="#krb5-set-trace-filename-specify-a-file-name-for-directing-trace-events" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_set_trace_filename"> -<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_set_trace_filename</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 char *<em> filename</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_trace_filename" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_set_trace_filename"> +<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_set_trace_filename</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">filename</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_set_trace_filename" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>filename</strong> - File name</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>KRB5_TRACE_NOSUPP Tracing is not supported in the library.</li> +<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>filename</strong> - File name</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">retval</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>KRB5_TRACE_NOSUPP Tracing is not supported in the library.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>Open <em>filename</em> for appending (creating it, if necessary) and set up a callback to write trace events to it.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">This function overrides the information passed through the <em>KRB5_TRACE</em> environment variable.</p> +<p class="admonition-title">Note</p> +<p>This function overrides the information passed through the <em>KRB5_TRACE</em> environment variable.</p> </div> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_set_trace_filename - Specify a file name for directing trace events.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_sname_match.html b/doc/html/appdev/refs/api/krb5_sname_match.html index 398d4400e397..254f784136e2 100644 --- a/doc/html/appdev/refs/api/krb5_sname_match.html +++ b/doc/html/appdev/refs/api/krb5_sname_match.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_sname_match - Test whether a principal matches a matching principal. — 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_sname_to_principal - Generate a full principal name from a service name." href="krb5_sname_to_principal.html" /> <link rel="prev" title="krb5_set_trace_filename - Specify a file name for directing trace events." href="krb5_set_trace_filename.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-sname-match-test-whether-a-principal-matches-a-matching-principal"> + <section id="krb5-sname-match-test-whether-a-principal-matches-a-matching-principal"> <h1>krb5_sname_match - Test whether a principal matches a matching principal.<a class="headerlink" href="#krb5-sname-match-test-whether-a-principal-matches-a-matching-principal" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_sname_match"> -<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean">krb5_boolean</a> <code class="descname">krb5_sname_match</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> matching</em>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> princ</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sname_match" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_sname_match"> +<a class="reference internal" href="../types/krb5_boolean.html#c.krb5_boolean" title="krb5_boolean"><span class="n"><span class="pre">krb5_boolean</span></span></a><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_sname_match</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">matching</span></span>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">princ</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sname_match" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>matching</strong> - Matching principal</p> -<p class="last"><strong>[in]</strong> <strong>princ</strong> - Principal to test</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">return:</th><td class="field-body"><ul class="first last simple"> -<li>TRUE if princ matches matching , FALSE otherwise.</li> +<p><strong>[in]</strong> <strong>princ</strong> - Principal to test</p> +</dd> +</dl> +<dl class="field-list simple"> +<dt class="field-odd">return</dt> +<dd class="field-odd"><ul class="simple"> +<li><p>TRUE if princ matches matching , FALSE otherwise.</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>If <em>matching</em> is NULL, return TRUE. If <em>matching</em> is not a matching principal, return the value of krb5_principal_compare(context, matching, princ).</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">A matching principal is a host-based principal with an empty realm and/or second data component (hostname). Profile configuration may cause the hostname to be ignored even if it is present. A principal matches a matching principal if the former has the same non-empty (and non-ignored) components of the latter.</p> -</div> +<p class="admonition-title">Note</p> +<p>A matching principal is a host-based principal with an empty realm and/or second data component (hostname). Profile configuration may cause the hostname to be ignored even if it is present. A principal matches a matching principal if the former has the same non-empty (and non-ignored) components of the latter.</p> </div> +</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_sname_match - Test whether a principal matches a matching principal.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_sname_to_principal.html b/doc/html/appdev/refs/api/krb5_sname_to_principal.html index 87d68dd9868a..342e08117c2d 100644 --- a/doc/html/appdev/refs/api/krb5_sname_to_principal.html +++ b/doc/html/appdev/refs/api/krb5_sname_to_principal.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_sname_to_principal - Generate a full principal name from a service name. — 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_unparse_name - Convert a krb5_principal structure to a string representation." href="krb5_unparse_name.html" /> <link rel="prev" title="krb5_sname_match - Test whether a principal matches a matching principal." href="krb5_sname_match.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,61 +52,55 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-sname-to-principal-generate-a-full-principal-name-from-a-service-name"> + <section id="krb5-sname-to-principal-generate-a-full-principal-name-from-a-service-name"> <h1>krb5_sname_to_principal - Generate a full principal name from a service name.<a class="headerlink" href="#krb5-sname-to-principal-generate-a-full-principal-name-from-a-service-name" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_sname_to_principal"> -<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_sname_to_principal</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 char *<em> hostname</em>, const char *<em> sname</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a><em> type</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> ret_princ</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sname_to_principal" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_sname_to_principal"> +<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_sname_to_principal</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><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">hostname</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">sname</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="n"><span class="pre">type</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ret_princ</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_sname_to_principal" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>hostname</strong> - Host name, or NULL to use local host</p> <p><strong>[in]</strong> <strong>sname</strong> - Service name, or NULL to use <strong>“host”</strong></p> <p><strong>[in]</strong> <strong>type</strong> - Principal type</p> -<p class="last"><strong>[out]</strong> <strong>ret_princ</strong> - Generated principal</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>ret_princ</strong> - Generated principal</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function converts a <em>hostname</em> and <em>sname</em> into <em>krb5_principal</em> structure <em>ret_princ</em> . The returned principal will be of the form <em>sname/hostname@REALM</em> where REALM is determined by <a class="reference internal" href="krb5_get_host_realm.html#c.krb5_get_host_realm" title="krb5_get_host_realm"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_host_realm()</span></code></a> . In some cases this may be the referral (empty) realm.</p> +</dd> +</dl> +<p>This function converts a <em>hostname</em> and <em>sname</em> into <em>krb5_principal</em> structure <em>ret_princ</em> . The returned principal will be of the form <em>sname/hostname@REALM</em> where REALM is determined by krb5_get_host_realm(). In some cases this may be the referral (empty) realm.</p> <p>The <em>type</em> can be one of the following:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_NT_SRV_HST.html#KRB5_NT_SRV_HST" title="KRB5_NT_SRV_HST"><code class="xref py py-data docutils literal"><span class="pre">KRB5_NT_SRV_HST</span></code></a> canonicalizes the host name before looking up the realm and generating the principal.</li> -<li><a class="reference internal" href="../macros/KRB5_NT_UNKNOWN.html#KRB5_NT_UNKNOWN" title="KRB5_NT_UNKNOWN"><code class="xref py py-data docutils literal"><span class="pre">KRB5_NT_UNKNOWN</span></code></a> accepts the hostname as given, and does not canonicalize it.</li> +<li><p>#KRB5_NT_SRV_HST canonicalizes the host name before looking up the realm and generating the principal.</p></li> +<li><p>#KRB5_NT_UNKNOWN accepts the hostname as given, and does not canonicalize it.</p></li> </ul> </div></blockquote> <p>Use krb5_free_principal to free <em>ret_princ</em> when it is no longer needed.</p> </div></blockquote> -</div> +</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_sname_to_principal - Generate a full principal name from a service name.</a></li> @@ -159,6 +144,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -166,8 +152,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_cksumtype.html b/doc/html/appdev/refs/api/krb5_string_to_cksumtype.html index 2692046f51cd..6d8b138251b5 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_cksumtype.html +++ b/doc/html/appdev/refs/api/krb5_string_to_cksumtype.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_string_to_cksumtype - Convert a string to a checksum type. — 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_string_to_deltat - Convert a string to a delta time value." href="krb5_string_to_deltat.html" /> <link rel="prev" title="krb5_set_real_time - Set time offset field in a krb5_context structure." href="krb5_set_real_time.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-cksumtype-convert-a-string-to-a-checksum-type"> + <section id="krb5-string-to-cksumtype-convert-a-string-to-a-checksum-type"> <h1>krb5_string_to_cksumtype - Convert a string to a checksum type.<a class="headerlink" href="#krb5-string-to-cksumtype-convert-a-string-to-a-checksum-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_cksumtype"> -<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_string_to_cksumtype</code><span class="sig-paren">(</span>char *<em> string</em>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a> *<em> cksumtypep</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_cksumtype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_cksumtype"> +<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_string_to_cksumtype</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">string</span></span>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksumtypep</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_cksumtype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>string</strong> - String to be converted</p> -<p class="last"><strong>[out]</strong> <strong>cksumtypep</strong> - Checksum type to be filled in</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 - EINVAL</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>string</strong> - String to be converted</p> +<p><strong>[out]</strong> <strong>cksumtypep</strong> - Checksum type to be filled in</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 - EINVAL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_string_to_cksumtype - Convert a string to a checksum type.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_deltat.html b/doc/html/appdev/refs/api/krb5_string_to_deltat.html index 81f11b6730ef..a87380dacce8 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_deltat.html +++ b/doc/html/appdev/refs/api/krb5_string_to_deltat.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_string_to_deltat - Convert a string to a delta time value. — 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_string_to_enctype - Convert a string to an encryption type." href="krb5_string_to_enctype.html" /> <link rel="prev" title="krb5_string_to_cksumtype - Convert a string to a checksum type." href="krb5_string_to_cksumtype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-deltat-convert-a-string-to-a-delta-time-value"> + <section id="krb5-string-to-deltat-convert-a-string-to-a-delta-time-value"> <h1>krb5_string_to_deltat - Convert a string to a delta time value.<a class="headerlink" href="#krb5-string-to-deltat-convert-a-string-to-a-delta-time-value" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_deltat"> -<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_string_to_deltat</code><span class="sig-paren">(</span>char *<em> string</em>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat">krb5_deltat</a> *<em> deltatp</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_deltat" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_deltat"> +<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_string_to_deltat</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">string</span></span>, <a class="reference internal" href="../types/krb5_deltat.html#c.krb5_deltat" title="krb5_deltat"><span class="n"><span class="pre">krb5_deltat</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">deltatp</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_deltat" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>string</strong> - String to be converted</p> -<p class="last"><strong>[out]</strong> <strong>deltatp</strong> - Delta time to be filled in</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 - KRB5_DELTAT_BADFORMAT</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>string</strong> - String to be converted</p> +<p><strong>[out]</strong> <strong>deltatp</strong> - Delta time to be filled in</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 - KRB5_DELTAT_BADFORMAT</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_string_to_deltat - Convert a string to a delta time value.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_enctype.html b/doc/html/appdev/refs/api/krb5_string_to_enctype.html index 56fe7b8de4f7..0e89d17f83c9 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_enctype.html +++ b/doc/html/appdev/refs/api/krb5_string_to_enctype.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_string_to_enctype - Convert a string to an encryption type. — 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_string_to_salttype - Convert a string to a salt type." href="krb5_string_to_salttype.html" /> <link rel="prev" title="krb5_string_to_deltat - Convert a string to a delta time value." href="krb5_string_to_deltat.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-enctype-convert-a-string-to-an-encryption-type"> + <section id="krb5-string-to-enctype-convert-a-string-to-an-encryption-type"> <h1>krb5_string_to_enctype - Convert a string to an encryption type.<a class="headerlink" href="#krb5-string-to-enctype-convert-a-string-to-an-encryption-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_enctype"> -<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_string_to_enctype</code><span class="sig-paren">(</span>char *<em> string</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a> *<em> enctypep</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_enctype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_enctype"> +<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_string_to_enctype</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">string</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">enctypep</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_enctype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>string</strong> - String to convert to an encryption type</p> -<p class="last"><strong>[out]</strong> <strong>enctypep</strong> - Encryption type</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 - EINVAL</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>string</strong> - String to convert to an encryption type</p> +<p><strong>[out]</strong> <strong>enctypep</strong> - Encryption type</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 - EINVAL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_string_to_enctype - Convert a string to an encryption type.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_key.html b/doc/html/appdev/refs/api/krb5_string_to_key.html index c3668bfa277c..3a3bd9180115 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_key.html +++ b/doc/html/appdev/refs/api/krb5_string_to_key.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_string_to_key — 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_use_enctype" href="krb5_use_enctype.html" /> <link rel="prev" title="krb5_process_key" href="krb5_process_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-key"> + <section id="krb5-string-to-key"> <h1>krb5_string_to_key<a class="headerlink" href="#krb5-string-to-key" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_key"> -<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_string_to_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_keyblock.html#c.krb5_keyblock" title="krb5_keyblock">krb5_keyblock</a> *<em> keyblock</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em>, const <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> salt</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_key" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_key"> +<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_string_to_key</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_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></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>, <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">data</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">salt</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_key" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> <p><strong>keyblock</strong></p> <p><strong>data</strong></p> -<p class="last"><strong>salt</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>salt</strong></p> +</dd> +</dl> <p>DEPRECATED See krb5_c_string_to_key()</p> -</div> +</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_string_to_key</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_salttype.html b/doc/html/appdev/refs/api/krb5_string_to_salttype.html index 7300fb7ec74c..8c6def7cd13f 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_salttype.html +++ b/doc/html/appdev/refs/api/krb5_string_to_salttype.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_string_to_salttype - Convert a string to a salt type. — 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_string_to_timestamp - Convert a string to a timestamp." href="krb5_string_to_timestamp.html" /> <link rel="prev" title="krb5_string_to_enctype - Convert a string to an encryption type." href="krb5_string_to_enctype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-salttype-convert-a-string-to-a-salt-type"> + <section id="krb5-string-to-salttype-convert-a-string-to-a-salt-type"> <h1>krb5_string_to_salttype - Convert a string to a salt type.<a class="headerlink" href="#krb5-string-to-salttype-convert-a-string-to-a-salt-type" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_salttype"> -<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_string_to_salttype</code><span class="sig-paren">(</span>char *<em> string</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> salttypep</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_salttype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_salttype"> +<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_string_to_salttype</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">string</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">salttypep</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_salttype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>string</strong> - String to convert to an encryption type</p> -<p class="last"><strong>[out]</strong> <strong>salttypep</strong> - Salt type to be filled in</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 - EINVAL</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>string</strong> - String to convert to an encryption type</p> +<p><strong>[out]</strong> <strong>salttypep</strong> - Salt type to be filled in</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 - EINVAL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_string_to_salttype - Convert a string to a salt type.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_string_to_timestamp.html b/doc/html/appdev/refs/api/krb5_string_to_timestamp.html index b37d75075fca..9e9dd02576e5 100644 --- a/doc/html/appdev/refs/api/krb5_string_to_timestamp.html +++ b/doc/html/appdev/refs/api/krb5_string_to_timestamp.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_string_to_timestamp - Convert a string to a timestamp. — 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_timeofday - Retrieve the current time with context specific time offset adjustment." href="krb5_timeofday.html" /> <link rel="prev" title="krb5_string_to_salttype - Convert a string to a salt type." href="krb5_string_to_salttype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,42 +52,36 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-string-to-timestamp-convert-a-string-to-a-timestamp"> + <section id="krb5-string-to-timestamp-convert-a-string-to-a-timestamp"> <h1>krb5_string_to_timestamp - Convert a string to a timestamp.<a class="headerlink" href="#krb5-string-to-timestamp-convert-a-string-to-a-timestamp" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_string_to_timestamp"> -<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_string_to_timestamp</code><span class="sig-paren">(</span>char *<em> string</em>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a> *<em> timestampp</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_timestamp" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_string_to_timestamp"> +<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_string_to_timestamp</span></span></span><span class="sig-paren">(</span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">string</span></span>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">timestampp</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_string_to_timestamp" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>string</strong> - String to be converted</p> -<p class="last"><strong>[out]</strong> <strong>timestampp</strong> - Pointer to timestamp</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 - EINVAL</li> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>string</strong> - String to be converted</p> +<p><strong>[out]</strong> <strong>timestampp</strong> - Pointer to timestamp</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 - EINVAL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_string_to_timestamp - Convert a string to a timestamp.</a></li> @@ -140,6 +125,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -147,8 +133,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_timeofday.html b/doc/html/appdev/refs/api/krb5_timeofday.html index b5e95ad97370..f60f4bd5a02e 100644 --- a/doc/html/appdev/refs/api/krb5_timeofday.html +++ b/doc/html/appdev/refs/api/krb5_timeofday.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_timeofday - Retrieve the current time with context specific time offset adjustment. — 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_timestamp_to_sfstring - Convert a timestamp to a string, with optional output padding." href="krb5_timestamp_to_sfstring.html" /> <link rel="prev" title="krb5_string_to_timestamp - Convert a string to a timestamp." href="krb5_string_to_timestamp.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-timeofday-retrieve-the-current-time-with-context-specific-time-offset-adjustment"> + <section id="krb5-timeofday-retrieve-the-current-time-with-context-specific-time-offset-adjustment"> <h1>krb5_timeofday - Retrieve the current time with context specific time offset adjustment.<a class="headerlink" href="#krb5-timeofday-retrieve-the-current-time-with-context-specific-time-offset-adjustment" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_timeofday"> -<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_timeofday</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a> *<em> timeret</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timeofday" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_timeofday"> +<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_timeofday</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">timeret</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timeofday" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[out]</strong> <strong>timeret</strong> - Timestamp to fill in</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 simple"> -<li>0 Success</li> +<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>[out]</strong> <strong>timeret</strong> - Timestamp to fill in</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function retrieves the system time of day with the context specific time offset adjustment.</p> -</div> +</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_timeofday - Retrieve the current time with context specific time offset adjustment.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_timestamp_to_sfstring.html b/doc/html/appdev/refs/api/krb5_timestamp_to_sfstring.html index fb53dcc7da76..8ce57c5e11a1 100644 --- a/doc/html/appdev/refs/api/krb5_timestamp_to_sfstring.html +++ b/doc/html/appdev/refs/api/krb5_timestamp_to_sfstring.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_timestamp_to_sfstring - Convert a timestamp to a string, with optional output padding. — 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_timestamp_to_string - Convert a timestamp to a string." href="krb5_timestamp_to_string.html" /> <link rel="prev" title="krb5_timeofday - Retrieve the current time with context specific time offset adjustment." href="krb5_timeofday.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-timestamp-to-sfstring-convert-a-timestamp-to-a-string-with-optional-output-padding"> + <section id="krb5-timestamp-to-sfstring-convert-a-timestamp-to-a-string-with-optional-output-padding"> <h1>krb5_timestamp_to_sfstring - Convert a timestamp to a string, with optional output padding.<a class="headerlink" href="#krb5-timestamp-to-sfstring-convert-a-timestamp-to-a-string-with-optional-output-padding" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_timestamp_to_sfstring"> -<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_timestamp_to_sfstring</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> timestamp</em>, char *<em> buffer</em>, size_t<em> buflen</em>, char *<em> pad</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timestamp_to_sfstring" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_timestamp_to_sfstring"> +<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_timestamp_to_sfstring</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">timestamp</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">pad</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timestamp_to_sfstring" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>timestamp</strong> - Timestamp to convert</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>timestamp</strong> - Timestamp to convert</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold the converted timestamp</p> <p><strong>[in]</strong> <strong>buflen</strong> - Length of buffer</p> -<p class="last"><strong>[in]</strong> <strong>pad</strong> - Optional value to pad <em>buffer</em> if converted timestamp does not fill it</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>pad</strong> - Optional value to pad <em>buffer</em> if converted timestamp does not fill it</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>If <em>pad</em> is not NULL, <em>buffer</em> is padded out to <em>buflen</em> - 1 characters with the value of * <em>pad</em> .</p> -</div> +</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_timestamp_to_sfstring - Convert a timestamp to a string, with optional output padding.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_timestamp_to_string.html b/doc/html/appdev/refs/api/krb5_timestamp_to_string.html index 3da0c2c4fecc..62370c13a54e 100644 --- a/doc/html/appdev/refs/api/krb5_timestamp_to_string.html +++ b/doc/html/appdev/refs/api/krb5_timestamp_to_string.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_timestamp_to_string - Convert a timestamp to a string. — 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_tkt_creds_free - Free a TGS request context." href="krb5_tkt_creds_free.html" /> <link rel="prev" title="krb5_timestamp_to_sfstring - Convert a timestamp to a string, with optional output padding." href="krb5_timestamp_to_sfstring.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,44 +52,38 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-timestamp-to-string-convert-a-timestamp-to-a-string"> + <section id="krb5-timestamp-to-string-convert-a-timestamp-to-a-string"> <h1>krb5_timestamp_to_string - Convert a timestamp to a string.<a class="headerlink" href="#krb5-timestamp-to-string-convert-a-timestamp-to-a-string" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_timestamp_to_string"> -<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_timestamp_to_string</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a><em> timestamp</em>, char *<em> buffer</em>, size_t<em> buflen</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timestamp_to_string" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_timestamp_to_string"> +<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_timestamp_to_string</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="n"><span class="pre">timestamp</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">buffer</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">buflen</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_timestamp_to_string" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>timestamp</strong> - Timestamp to convert</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>timestamp</strong> - Timestamp to convert</p> <p><strong>[out]</strong> <strong>buffer</strong> - Buffer to hold converted timestamp</p> -<p class="last"><strong>[in]</strong> <strong>buflen</strong> - Storage available in <em>buffer</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>buflen</strong> - Storage available in <em>buffer</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>The string is returned in the locale’s appropriate date and time representation.</p> -</div> +</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_timestamp_to_string - Convert a timestamp to a string.</a></li> @@ -142,6 +127,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -149,8 +135,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_free.html b/doc/html/appdev/refs/api/krb5_tkt_creds_free.html index b66b14fa0703..e7122d6c9e5a 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_free.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_free.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_tkt_creds_free - Free a TGS request context. — 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_tkt_creds_get - Synchronously obtain credentials using a TGS request context." href="krb5_tkt_creds_get.html" /> <link rel="prev" title="krb5_timestamp_to_string - Convert a timestamp to a string." href="krb5_timestamp_to_string.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-free-free-a-tgs-request-context"> + <section id="krb5-tkt-creds-free-free-a-tgs-request-context"> <h1>krb5_tkt_creds_free - Free a TGS request context.<a class="headerlink" href="#krb5-tkt-creds-free-free-a-tgs-request-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_free"> -void <code class="descname">krb5_tkt_creds_free</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a><em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_free" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_free"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_tkt_creds_free</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_free" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>ctx</strong> - TGS request context</p> -</td> -</tr> -</tbody> -</table> +<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>ctx</strong> - TGS request context</p> +</dd> +</dl> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_free - Free a TGS request context.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_tkt_creds_free</code><span class="sig-paren">(< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ void <code class="descname">krb5_tkt_creds_free</code><span class="sig-paren">(< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_get.html b/doc/html/appdev/refs/api/krb5_tkt_creds_get.html index d0a107adb8ea..efb93e70d968 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_get.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_get.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_tkt_creds_get - Synchronously obtain credentials using a TGS request context. — 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_tkt_creds_get_creds - Retrieve acquired credentials from a TGS request context." href="krb5_tkt_creds_get_creds.html" /> <link rel="prev" title="krb5_tkt_creds_free - Free a TGS request context." href="krb5_tkt_creds_free.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,47 +52,41 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-get-synchronously-obtain-credentials-using-a-tgs-request-context"> + <section id="krb5-tkt-creds-get-synchronously-obtain-credentials-using-a-tgs-request-context"> <h1>krb5_tkt_creds_get - Synchronously obtain credentials using a TGS request context.<a class="headerlink" href="#krb5-tkt-creds-get-synchronously-obtain-credentials-using-a-tgs-request-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_get"> -<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_tkt_creds_get</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a><em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_get"> +<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_tkt_creds_get</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> -<p class="last"><strong>[in]</strong> <strong>ctx</strong> - TGS request context</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> +<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>ctx</strong> - TGS request context</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> -<p>This function synchronously obtains credentials using a context created by <a class="reference internal" href="krb5_tkt_creds_init.html#c.krb5_tkt_creds_init" title="krb5_tkt_creds_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_init()</span></code></a> . On successful return, the credentials can be retrieved with <a class="reference internal" href="krb5_tkt_creds_get_creds.html#c.krb5_tkt_creds_get_creds" title="krb5_tkt_creds_get_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_get_creds()</span></code></a> .</p> +</dd> +</dl> +<p>This function synchronously obtains credentials using a context created by krb5_tkt_creds_init(). On successful return, the credentials can be retrieved with krb5_tkt_creds_get_creds().</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_get - Synchronously obtain credentials using a TGS request context.</a></li> @@ -145,6 +130,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -152,8 +138,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_get_creds.html b/doc/html/appdev/refs/api/krb5_tkt_creds_get_creds.html index 61cd0fb2725d..4b73a25893f1 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_get_creds.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_get_creds.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_tkt_creds_get_creds - Retrieve acquired credentials from a TGS request context. — 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_tkt_creds_get_times - Retrieve ticket times from a TGS request context." href="krb5_tkt_creds_get_times.html" /> <link rel="prev" title="krb5_tkt_creds_get - Synchronously obtain credentials using a TGS request context." href="krb5_tkt_creds_get.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-get-creds-retrieve-acquired-credentials-from-a-tgs-request-context"> + <section id="krb5-tkt-creds-get-creds-retrieve-acquired-credentials-from-a-tgs-request-context"> <h1>krb5_tkt_creds_get_creds - Retrieve acquired credentials from a TGS request context.<a class="headerlink" href="#krb5-tkt-creds-get-creds-retrieve-acquired-credentials-from-a-tgs-request-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_get_creds"> -<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_tkt_creds_get_creds</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_get_creds"> +<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_tkt_creds_get_creds</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - TGS request context</p> -<p class="last"><strong>[out]</strong> <strong>creds</strong> - Acquired credentials</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>creds</strong> - Acquired credentials</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> -<p>This function copies the acquired initial credentials from <em>ctx</em> into <em>creds</em> , after the successful completion of <a class="reference internal" href="krb5_tkt_creds_get.html#c.krb5_tkt_creds_get" title="krb5_tkt_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_get()</span></code></a> or <a class="reference internal" href="krb5_tkt_creds_step.html#c.krb5_tkt_creds_step" title="krb5_tkt_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_step()</span></code></a> . Use <a class="reference internal" href="krb5_free_cred_contents.html#c.krb5_free_cred_contents" title="krb5_free_cred_contents"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_cred_contents()</span></code></a> to free <em>creds</em> when it is no longer needed.</p> +</dd> +</dl> +<p>This function copies the acquired initial credentials from <em>ctx</em> into <em>creds</em> , after the successful completion of krb5_tkt_creds_get() or krb5_tkt_creds_step(). Use krb5_free_cred_contents() to free <em>creds</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_get_creds - Retrieve acquired credentials from a TGS request context.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_get_times.html b/doc/html/appdev/refs/api/krb5_tkt_creds_get_times.html index 61f17a14dcfc..5cfbf4c0fb60 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_get_times.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_get_times.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_tkt_creds_get_times - Retrieve ticket times from a TGS request context. — 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_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service." href="krb5_tkt_creds_init.html" /> <link rel="prev" title="krb5_tkt_creds_get_creds - Retrieve acquired credentials from a TGS request context." href="krb5_tkt_creds_get_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,48 +52,42 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-get-times-retrieve-ticket-times-from-a-tgs-request-context"> + <section id="krb5-tkt-creds-get-times-retrieve-ticket-times-from-a-tgs-request-context"> <h1>krb5_tkt_creds_get_times - Retrieve ticket times from a TGS request context.<a class="headerlink" href="#krb5-tkt-creds-get-times-retrieve-ticket-times-from-a-tgs-request-context" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_get_times"> -<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_tkt_creds_get_times</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_ticket_times.html#c.krb5_ticket_times" title="krb5_ticket_times">krb5_ticket_times</a> *<em> times</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get_times" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_get_times"> +<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_tkt_creds_get_times</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</span></span>, <a class="reference internal" href="../types/krb5_ticket_times.html#c.krb5_ticket_times" title="krb5_ticket_times"><span class="n"><span class="pre">krb5_ticket_times</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">times</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_get_times" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - TGS request context</p> -<p class="last"><strong>[out]</strong> <strong>times</strong> - Ticket times for acquired credentials</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>times</strong> - Ticket times for acquired credentials</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> -<p>The TGS request context must have completed obtaining credentials via either <a class="reference internal" href="krb5_tkt_creds_get.html#c.krb5_tkt_creds_get" title="krb5_tkt_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_get()</span></code></a> or <a class="reference internal" href="krb5_tkt_creds_step.html#c.krb5_tkt_creds_step" title="krb5_tkt_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_step()</span></code></a> .</p> +</dd> +</dl> +<p>The TGS request context must have completed obtaining credentials via either krb5_tkt_creds_get() or krb5_tkt_creds_step().</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_get_times - Retrieve ticket times from a TGS request context.</a></li> @@ -146,6 +131,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -153,8 +139,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_init.html b/doc/html/appdev/refs/api/krb5_tkt_creds_init.html index 92c54f5dfa66..052985028c0f 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_init.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_init.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_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service. — 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_tkt_creds_step - Get the next KDC request in a TGS exchange." href="krb5_tkt_creds_step.html" /> <link rel="prev" title="krb5_tkt_creds_get_times - Retrieve ticket times from a TGS request context." href="krb5_tkt_creds_get_times.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,52 +52,46 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-init-create-a-context-to-get-credentials-from-a-kdc-s-ticket-granting-service"> + <section id="krb5-tkt-creds-init-create-a-context-to-get-credentials-from-a-kdc-s-ticket-granting-service"> <h1>krb5_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service.<a class="headerlink" href="#krb5-tkt-creds-init-create-a-context-to-get-credentials-from-a-kdc-s-ticket-granting-service" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_init"> -<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_tkt_creds_init</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a><em> ccache</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags">krb5_flags</a><em> options</em>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a> *<em> ctx</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_init"> +<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_tkt_creds_init</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>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_flags.html#c.krb5_flags" title="krb5_flags"><span class="n"><span class="pre">krb5_flags</span></span></a><span class="w"> </span><span class="n"><span class="pre">options</span></span>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ctx</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ccache</strong> - Credential cache handle</p> <p><strong>[in]</strong> <strong>creds</strong> - Input credentials</p> -<p><strong>[in]</strong> <strong>options</strong> - <code class="xref py py-data docutils literal"><span class="pre">KRB5_GC</span></code> options for this request.</p> -<p class="last"><strong>[out]</strong> <strong>ctx</strong> - New TGS request context</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>options</strong> - Options (see KRB5_GC macros)</p> +<p><strong>[out]</strong> <strong>ctx</strong> - New TGS request context</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 prepares to obtain credentials matching <em>creds</em> , either by retrieving them from <em>ccache</em> or by making requests to ticket-granting services beginning with a ticket-granting ticket for the client principal’s realm.</p> -<p>The resulting TGS acquisition context can be used asynchronously with <a class="reference internal" href="krb5_tkt_creds_step.html#c.krb5_tkt_creds_step" title="krb5_tkt_creds_step"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_step()</span></code></a> or synchronously with <a class="reference internal" href="krb5_tkt_creds_get.html#c.krb5_tkt_creds_get" title="krb5_tkt_creds_get"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_get()</span></code></a> . See also <a class="reference internal" href="krb5_get_credentials.html#c.krb5_get_credentials" title="krb5_get_credentials"><code class="xref c c-func docutils literal"><span class="pre">krb5_get_credentials()</span></code></a> for synchronous use.</p> -<p>Use <a class="reference internal" href="krb5_tkt_creds_free.html#c.krb5_tkt_creds_free" title="krb5_tkt_creds_free"><code class="xref c c-func docutils literal"><span class="pre">krb5_tkt_creds_free()</span></code></a> to free <em>ctx</em> when it is no longer needed.</p> +<p>The resulting TGS acquisition context can be used asynchronously with krb5_tkt_creds_step() or synchronously with krb5_tkt_creds_get(). See also krb5_get_credentials() for synchronous use.</p> +<p>Use krb5_tkt_creds_free() to free <em>ctx</em> when it is no longer needed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service.</a></li> @@ -150,6 +135,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -157,8 +143,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_tkt_creds_step.html b/doc/html/appdev/refs/api/krb5_tkt_creds_step.html index 03b41924554b..7eeb50f2426b 100644 --- a/doc/html/appdev/refs/api/krb5_tkt_creds_step.html +++ b/doc/html/appdev/refs/api/krb5_tkt_creds_step.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_tkt_creds_step - Get the next KDC request in a TGS exchange. — 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_unmarshal_credentials - Deserialize a krb5_creds object." href="krb5_unmarshal_credentials.html" /> <link rel="prev" title="krb5_tkt_creds_init - Create a context to get credentials from a KDC’s Ticket Granting Service." href="krb5_tkt_creds_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,53 +52,47 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-tkt-creds-step-get-the-next-kdc-request-in-a-tgs-exchange"> + <section id="krb5-tkt-creds-step-get-the-next-kdc-request-in-a-tgs-exchange"> <h1>krb5_tkt_creds_step - Get the next KDC request in a TGS exchange.<a class="headerlink" href="#krb5-tkt-creds-step-get-the-next-kdc-request-in-a-tgs-exchange" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_tkt_creds_step"> -<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_tkt_creds_step</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context">krb5_tkt_creds_context</a><em> ctx</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> in</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> out</em>, <a class="reference internal" href="../types/krb5_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> realm</em>, unsigned int *<em> flags</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_step" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_tkt_creds_step"> +<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_tkt_creds_step</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>, <a class="reference internal" href="../types/krb5_tkt_creds_context.html#c.krb5_tkt_creds_context" title="krb5_tkt_creds_context"><span class="n"><span class="pre">krb5_tkt_creds_context</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctx</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">in</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">out</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">realm</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">flags</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_tkt_creds_step" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - TGS request context</p> <p><strong>[in]</strong> <strong>in</strong> - KDC response (empty on the first call)</p> <p><strong>[out]</strong> <strong>out</strong> - Next KDC request</p> <p><strong>[out]</strong> <strong>realm</strong> - Realm for next KDC request</p> -<p class="last"><strong>[out]</strong> <strong>flags</strong> - Output flags</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>flags</strong> - Output flags</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 constructs the next KDC request for a TGS exchange, allowing the caller to control the transport of KDC requests and replies. On the first call, <em>in</em> should be set to an empty buffer; on subsequent calls, it should be set to the KDC’s reply to the previous request.</p> -<p>If more requests are needed, <em>flags</em> will be set to <a class="reference internal" href="../macros/KRB5_TKT_CREDS_STEP_FLAG_CONTINUE.html#KRB5_TKT_CREDS_STEP_FLAG_CONTINUE" title="KRB5_TKT_CREDS_STEP_FLAG_CONTINUE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TKT_CREDS_STEP_FLAG_CONTINUE</span></code></a> and the next request will be placed in <em>out</em> . If no more requests are needed, <em>flags</em> will not contain <a class="reference internal" href="../macros/KRB5_TKT_CREDS_STEP_FLAG_CONTINUE.html#KRB5_TKT_CREDS_STEP_FLAG_CONTINUE" title="KRB5_TKT_CREDS_STEP_FLAG_CONTINUE"><code class="xref py py-data docutils literal"><span class="pre">KRB5_TKT_CREDS_STEP_FLAG_CONTINUE</span></code></a> and <em>out</em> will be empty.</p> +<p>If more requests are needed, <em>flags</em> will be set to #KRB5_TKT_CREDS_STEP_FLAG_CONTINUE and the next request will be placed in <em>out</em> . If no more requests are needed, <em>flags</em> will not contain #KRB5_TKT_CREDS_STEP_FLAG_CONTINUE and <em>out</em> will be empty.</p> <p>If this function returns <strong>KRB5KRB_ERR_RESPONSE_TOO_BIG</strong> , the caller should transmit the next request using TCP rather than UDP. If this function returns any other error, the TGS exchange has failed.</p> <div class="admonition note"> -<p class="first admonition-title">Note</p> -<p class="last">New in 1.9</p> -</div> +<p class="admonition-title">Note</p> +<p>New in 1.9</p> </div> +</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_tkt_creds_step - Get the next KDC request in a TGS exchange.</a></li> @@ -151,6 +136,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -158,8 +144,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_unmarshal_credentials.html b/doc/html/appdev/refs/api/krb5_unmarshal_credentials.html index d8c55c1085b2..2f2c35948deb 100644 --- a/doc/html/appdev/refs/api/krb5_unmarshal_credentials.html +++ b/doc/html/appdev/refs/api/krb5_unmarshal_credentials.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_unmarshal_credentials - Deserialize a krb5_creds object. — 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_verify_init_creds - Verify initial credentials against a keytab." href="krb5_verify_init_creds.html" /> <link rel="prev" title="krb5_tkt_creds_step - Get the next KDC request in a TGS exchange." href="krb5_tkt_creds_step.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,45 +52,39 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-unmarshal-credentials-deserialize-a-krb5-creds-object"> + <section id="krb5-unmarshal-credentials-deserialize-a-krb5-creds-object"> <h1>krb5_unmarshal_credentials - Deserialize a krb5_creds object.<a class="headerlink" href="#krb5-unmarshal-credentials-deserialize-a-krb5-creds-object" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_unmarshal_credentials"> -<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_unmarshal_credentials</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_data.html#c.krb5_data" title="krb5_data">krb5_data</a> *<em> data</em>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> **<em> creds_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unmarshal_credentials" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_unmarshal_credentials"> +<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_unmarshal_credentials</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_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">data</span></span>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds_out</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unmarshal_credentials" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>data</strong> - The serialized credentials</p> -<p class="last"><strong>[out]</strong> <strong>creds_out</strong> - The resulting creds object</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>creds_out</strong> - The resulting creds object</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>Deserialize <em>data</em> to credentials in the format used by the FILE ccache format (vesion 4) and KCM ccache protocol.</p> -<p>Use <a class="reference internal" href="krb5_free_creds.html#c.krb5_free_creds" title="krb5_free_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_creds()</span></code></a> to free <em>creds_out</em> when it is no longer needed.</p> -</div> +<p>Use krb5_free_creds() to free <em>creds_out</em> when it is no longer needed.</p> +</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_unmarshal_credentials - Deserialize a krb5_creds object.</a></li> @@ -143,6 +128,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -150,8 +136,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_unparse_name.html b/doc/html/appdev/refs/api/krb5_unparse_name.html index 301c9c28363f..8e3a717bb1d8 100644 --- a/doc/html/appdev/refs/api/krb5_unparse_name.html +++ b/doc/html/appdev/refs/api/krb5_unparse_name.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_unparse_name - Convert a krb5_principal structure to a string representation. — 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_unparse_name_ext - Convert krb5_principal structure to string and length." href="krb5_unparse_name_ext.html" /> <link rel="prev" title="krb5_sname_to_principal - Generate a full principal name from a service name." href="krb5_sname_to_principal.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-unparse-name-convert-a-krb5-principal-structure-to-a-string-representation"> + <section id="krb5-unparse-name-convert-a-krb5-principal-structure-to-a-string-representation"> <h1>krb5_unparse_name - Convert a krb5_principal structure to a string representation.<a class="headerlink" href="#krb5-unparse-name-convert-a-krb5-principal-structure-to-a-string-representation" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_unparse_name"> -<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_unparse_name</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, char **<em> name</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_unparse_name"> +<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_unparse_name</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal</p> -<p class="last"><strong>[out]</strong> <strong>name</strong> - String representation of principal name</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>name</strong> - String representation of principal name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>The resulting string representation uses the format and quoting conventions described for <a class="reference internal" href="krb5_parse_name.html#c.krb5_parse_name" title="krb5_parse_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_parse_name()</span></code></a> .</p> -<p>Use <a class="reference internal" href="krb5_free_unparsed_name.html#c.krb5_free_unparsed_name" title="krb5_free_unparsed_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_unparsed_name()</span></code></a> to free <em>name</em> when it is no longer needed.</p> -</div> +</dd> +</dl> +<p>The resulting string representation uses the format and quoting conventions described for krb5_parse_name().</p> +<p>Use krb5_free_unparsed_name() to free <em>name</em> when it is no longer needed.</p> +</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_unparse_name - Convert a krb5_principal structure to a string representation.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_unparse_name_ext.html b/doc/html/appdev/refs/api/krb5_unparse_name_ext.html index 7103a13c4c3c..cdb3f3f564a8 100644 --- a/doc/html/appdev/refs/api/krb5_unparse_name_ext.html +++ b/doc/html/appdev/refs/api/krb5_unparse_name_ext.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_unparse_name_ext - Convert krb5_principal structure to string and length. — 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_unparse_name_flags - Convert krb5_principal structure to a string with flags." href="krb5_unparse_name_flags.html" /> <link rel="prev" title="krb5_unparse_name - Convert a krb5_principal structure to a string representation." href="krb5_unparse_name.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,51 +52,45 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-unparse-name-ext-convert-krb5-principal-structure-to-string-and-length"> + <section id="krb5-unparse-name-ext-convert-krb5-principal-structure-to-string-and-length"> <h1>krb5_unparse_name_ext - Convert krb5_principal structure to string and length.<a class="headerlink" href="#krb5-unparse-name-ext-convert-krb5-principal-structure-to-string-and-length" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_unparse_name_ext"> -<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_unparse_name_ext</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, char **<em> name</em>, unsigned int *<em> size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_ext" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_unparse_name_ext"> +<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_unparse_name_ext</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_ext" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal</p> <p><strong>[inout]</strong> <strong>name</strong> - String representation of principal name</p> -<p class="last"><strong>[inout]</strong> <strong>size</strong> - Size of unparsed name</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 simple"> -<li>0 Success</li> +<p><strong>[inout]</strong> <strong>size</strong> - Size of unparsed name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes. On failure name is set to NULL</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes. On failure name is set to NULL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>This function is similar to <a class="reference internal" href="krb5_unparse_name.html#c.krb5_unparse_name" title="krb5_unparse_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_unparse_name()</span></code></a> , but allows the use of an existing buffer for the result. If size is not NULL, then <em>name</em> must point to either NULL or an existing buffer of at least the size pointed to by <em>size</em> . The buffer will be allocated or resized if necessary, with the new pointer stored into <em>name</em> . Whether or not the buffer is resized, the necessary space for the result, including null terminator, will be stored into <em>size</em> .</p> -<p>If size is NULL, this function behaves exactly as <a class="reference internal" href="krb5_unparse_name.html#c.krb5_unparse_name" title="krb5_unparse_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_unparse_name()</span></code></a> .</p> -</div> +</dd> +</dl> +<p>This function is similar to krb5_unparse_name(), but allows the use of an existing buffer for the result. If size is not NULL, then <em>name</em> must point to either NULL or an existing buffer of at least the size pointed to by <em>size</em> . The buffer will be allocated or resized if necessary, with the new pointer stored into <em>name</em> . Whether or not the buffer is resized, the necessary space for the result, including null terminator, will be stored into <em>size</em> .</p> +<p>If size is NULL, this function behaves exactly as krb5_unparse_name().</p> +</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_unparse_name_ext - Convert krb5_principal structure to string and length.</a></li> @@ -149,6 +134,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -156,8 +142,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_unparse_name_flags.html b/doc/html/appdev/refs/api/krb5_unparse_name_flags.html index ab3556dee864..68687f4d4475 100644 --- a/doc/html/appdev/refs/api/krb5_unparse_name_flags.html +++ b/doc/html/appdev/refs/api/krb5_unparse_name_flags.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_unparse_name_flags - Convert krb5_principal structure to a string with flags. — 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_unparse_name_flags_ext - Convert krb5_principal structure to string format with flags." href="krb5_unparse_name_flags_ext.html" /> <link rel="prev" title="krb5_unparse_name_ext - Convert krb5_principal structure to string and length." href="krb5_unparse_name_ext.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,61 +52,55 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-unparse-name-flags-convert-krb5-principal-structure-to-a-string-with-flags"> + <section id="krb5-unparse-name-flags-convert-krb5-principal-structure-to-a-string-with-flags"> <h1>krb5_unparse_name_flags - Convert krb5_principal structure to a string with flags.<a class="headerlink" href="#krb5-unparse-name-flags-convert-krb5-principal-structure-to-a-string-with-flags" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_unparse_name_flags"> -<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_unparse_name_flags</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, int<em> flags</em>, char **<em> name</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_flags" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_unparse_name_flags"> +<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_unparse_name_flags</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_flags" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal</p> <p><strong>[in]</strong> <strong>flags</strong> - Flags</p> -<p class="last"><strong>[out]</strong> <strong>name</strong> - String representation of principal name</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>name</strong> - String representation of principal name</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes. On failure name is set to NULL</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes. On failure name is set to NULL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -<p>Similar to <a class="reference internal" href="krb5_unparse_name.html#c.krb5_unparse_name" title="krb5_unparse_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_unparse_name()</span></code></a> , this function converts a krb5_principal structure to a string representation.</p> +</dd> +</dl> +<p>Similar to krb5_unparse_name(), this function converts a krb5_principal structure to a string representation.</p> <p>The following flags are valid:</p> <blockquote> <div><blockquote> <div><ul class="simple"> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_UNPARSE_SHORT.html#KRB5_PRINCIPAL_UNPARSE_SHORT" title="KRB5_PRINCIPAL_UNPARSE_SHORT"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_UNPARSE_SHORT</span></code></a> - omit realm if it is the local realm</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_UNPARSE_NO_REALM.html#KRB5_PRINCIPAL_UNPARSE_NO_REALM" title="KRB5_PRINCIPAL_UNPARSE_NO_REALM"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_UNPARSE_NO_REALM</span></code></a> - omit realm</li> -<li><a class="reference internal" href="../macros/KRB5_PRINCIPAL_UNPARSE_DISPLAY.html#KRB5_PRINCIPAL_UNPARSE_DISPLAY" title="KRB5_PRINCIPAL_UNPARSE_DISPLAY"><code class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_UNPARSE_DISPLAY</span></code></a> - do not quote special characters</li> +<li><p>#KRB5_PRINCIPAL_UNPARSE_SHORT - omit realm if it is the local realm</p></li> +<li><p>#KRB5_PRINCIPAL_UNPARSE_NO_REALM - omit realm</p></li> +<li><p>#KRB5_PRINCIPAL_UNPARSE_DISPLAY - do not quote special characters</p></li> </ul> </div></blockquote> -<p>Use <a class="reference internal" href="krb5_free_unparsed_name.html#c.krb5_free_unparsed_name" title="krb5_free_unparsed_name"><code class="xref c c-func docutils literal"><span class="pre">krb5_free_unparsed_name()</span></code></a> to free <em>name</em> when it is no longer needed.</p> +<p>Use krb5_free_unparsed_name() to free <em>name</em> when it is no longer needed.</p> </div></blockquote> -</div> +</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_unparse_name_flags - Convert krb5_principal structure to a string with flags.</a></li> @@ -159,6 +144,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -166,8 +152,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_unparse_name_flags_ext.html b/doc/html/appdev/refs/api/krb5_unparse_name_flags_ext.html index 4abac087e8c2..bfda9acabbf2 100644 --- a/doc/html/appdev/refs/api/krb5_unparse_name_flags_ext.html +++ b/doc/html/appdev/refs/api/krb5_unparse_name_flags_ext.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_unparse_name_flags_ext - Convert krb5_principal structure to string format with flags. — 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_us_timeofday - Retrieve the system time of day, in sec and ms, since the epoch." href="krb5_us_timeofday.html" /> <link rel="prev" title="krb5_unparse_name_flags - Convert krb5_principal structure to a string with flags." href="krb5_unparse_name_flags.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,50 +52,44 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-unparse-name-flags-ext-convert-krb5-principal-structure-to-string-format-with-flags"> + <section id="krb5-unparse-name-flags-ext-convert-krb5-principal-structure-to-string-format-with-flags"> <h1>krb5_unparse_name_flags_ext - Convert krb5_principal structure to string format with flags.<a class="headerlink" href="#krb5-unparse-name-flags-ext-convert-krb5-principal-structure-to-string-format-with-flags" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_unparse_name_flags_ext"> -<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_unparse_name_flags_ext</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal">krb5_const_principal</a><em> principal</em>, int<em> flags</em>, char **<em> name</em>, unsigned int *<em> size</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_flags_ext" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_unparse_name_flags_ext"> +<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_unparse_name_flags_ext</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>, <a class="reference internal" href="../types/krb5_const_principal.html#c.krb5_const_principal" title="krb5_const_principal"><span class="n"><span class="pre">krb5_const_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">principal</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">flags</span></span>, <span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">name</span></span>, <span class="kt"><span class="pre">unsigned</span></span><span class="w"> </span><span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">size</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_unparse_name_flags_ext" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>principal</strong> - Principal</p> <p><strong>[in]</strong> <strong>flags</strong> - Flags</p> <p><strong>[out]</strong> <strong>name</strong> - Single string format of principal name</p> -<p class="last"><strong>[out]</strong> <strong>size</strong> - Size of unparsed name buffer</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>size</strong> - Size of unparsed name buffer</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes. On failure name is set to NULL</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes. On failure name is set to NULL</p></li> </ul> -</td> -</tr> -</tbody> -</table> -</div> +</dd> +</dl> +</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_unparse_name_flags_ext - Convert krb5_principal structure to string format with flags.</a></li> @@ -148,6 +133,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -155,8 +141,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_us_timeofday.html b/doc/html/appdev/refs/api/krb5_us_timeofday.html index 303f5126a7cb..3b2b43225f8a 100644 --- a/doc/html/appdev/refs/api/krb5_us_timeofday.html +++ b/doc/html/appdev/refs/api/krb5_us_timeofday.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_us_timeofday - Retrieve the system time of day, in sec and ms, since the epoch. — 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_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data." href="krb5_verify_authdata_kdc_issued.html" /> <link rel="prev" title="krb5_unparse_name_flags_ext - Convert krb5_principal structure to string format with flags." href="krb5_unparse_name_flags_ext.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-us-timeofday-retrieve-the-system-time-of-day-in-sec-and-ms-since-the-epoch"> + <section id="krb5-us-timeofday-retrieve-the-system-time-of-day-in-sec-and-ms-since-the-epoch"> <h1>krb5_us_timeofday - Retrieve the system time of day, in sec and ms, since the epoch.<a class="headerlink" href="#krb5-us-timeofday-retrieve-the-system-time-of-day-in-sec-and-ms-since-the-epoch" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_us_timeofday"> -<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_us_timeofday</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp">krb5_timestamp</a> *<em> seconds</em>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32">krb5_int32</a> *<em> microseconds</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_us_timeofday" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_us_timeofday"> +<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_us_timeofday</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>, <a class="reference internal" href="../types/krb5_timestamp.html#c.krb5_timestamp" title="krb5_timestamp"><span class="n"><span class="pre">krb5_timestamp</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">seconds</span></span>, <a class="reference internal" href="../types/krb5_int32.html#c.krb5_int32" title="krb5_int32"><span class="n"><span class="pre">krb5_int32</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">microseconds</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_us_timeofday" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>[out]</strong> <strong>seconds</strong> - System timeofday, seconds portion</p> -<p class="last"><strong>[out]</strong> <strong>microseconds</strong> - System timeofday, microseconds portion</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 simple"> -<li>0 Success</li> +<p><strong>[out]</strong> <strong>microseconds</strong> - System timeofday, microseconds portion</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</p></li> </ul> -</td> -</tr> -<tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple"> -<li>Kerberos error codes</li> +</dd> +<dt class="field-even">return</dt> +<dd class="field-even"><ul class="simple"> +<li><p>Kerberos error codes</p></li> </ul> -</td> -</tr> -</tbody> -</table> +</dd> +</dl> <p>This function retrieves the system time of day with the context specific time offset adjustment.</p> -</div> +</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_us_timeofday - Retrieve the system time of day, in sec and ms, since the epoch.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_use_enctype.html b/doc/html/appdev/refs/api/krb5_use_enctype.html index 73ccc66370ba..dd9fbcd42010 100644 --- a/doc/html/appdev/refs/api/krb5_use_enctype.html +++ b/doc/html/appdev/refs/api/krb5_use_enctype.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_use_enctype — 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_verify_checksum" href="krb5_verify_checksum.html" /> <link rel="prev" title="krb5_string_to_key" href="krb5_string_to_key.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-use-enctype"> + <section id="krb5-use-enctype"> <h1>krb5_use_enctype<a class="headerlink" href="#krb5-use-enctype" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_use_enctype"> -<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_use_enctype</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block">krb5_encrypt_block</a> *<em> eblock</em>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype">krb5_enctype</a><em> enctype</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_use_enctype" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_use_enctype"> +<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_use_enctype</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>, <a class="reference internal" href="../types/krb5_encrypt_block.html#c.krb5_encrypt_block" title="krb5_encrypt_block"><span class="n"><span class="pre">krb5_encrypt_block</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">eblock</span></span>, <a class="reference internal" href="../types/krb5_enctype.html#c.krb5_enctype" title="krb5_enctype"><span class="n"><span class="pre">krb5_enctype</span></span></a><span class="w"> </span><span class="n"><span class="pre">enctype</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_use_enctype" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>eblock</strong></p> -<p class="last"><strong>enctype</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>enctype</strong></p> +</dd> +</dl> <p>DEPRECATED Replaced by krb5_c_* API family.</p> -</div> +</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_use_enctype</a></li> @@ -131,6 +120,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_verify_authdata_kdc_issued.html b/doc/html/appdev/refs/api/krb5_verify_authdata_kdc_issued.html index 83aad1f28c63..4cdbb6444873 100644 --- a/doc/html/appdev/refs/api/krb5_verify_authdata_kdc_issued.html +++ b/doc/html/appdev/refs/api/krb5_verify_authdata_kdc_issued.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_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data. — 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_425_conv_principal - Convert a Kerberos V4 principal to a Kerberos V5 principal." href="krb5_425_conv_principal.html" /> <link rel="prev" title="krb5_us_timeofday - Retrieve the system time of day, in sec and ms, since the epoch." href="krb5_us_timeofday.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-verify-authdata-kdc-issued-unwrap-and-verify-ad-kdcissued-authorization-data"> + <section id="krb5-verify-authdata-kdc-issued-unwrap-and-verify-ad-kdcissued-authorization-data"> <h1>krb5_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data.<a class="headerlink" href="#krb5-verify-authdata-kdc-issued-unwrap-and-verify-ad-kdcissued-authorization-data" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_verify_authdata_kdc_issued"> -<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_verify_authdata_kdc_issued</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>, const <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> *<em> ad_kdcissued</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em> issuer</em>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata">krb5_authdata</a> ***<em> authdata</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_authdata_kdc_issued" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_verify_authdata_kdc_issued"> +<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_verify_authdata_kdc_issued</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>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ad_kdcissued</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">issuer</span></span>, <a class="reference internal" href="../types/krb5_authdata.html#c.krb5_authdata" title="krb5_authdata"><span class="n"><span class="pre">krb5_authdata</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">authdata</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_authdata_kdc_issued" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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> - Session key</p> <p><strong>[in]</strong> <strong>ad_kdcissued</strong> - AD-KDCIssued authorization data to be unwrapped</p> <p><strong>[out]</strong> <strong>issuer</strong> - Name of issuing principal (or NULL)</p> -<p class="last"><strong>[out]</strong> <strong>authdata</strong> - Unwrapped list of authorization data</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[out]</strong> <strong>authdata</strong> - Unwrapped list of authorization data</p> +</dd> +</dl> <p>This function unwraps an AD-KDCIssued authdatum (see RFC 4120 section 5.2.6.2) and verifies its signature against <em>key</em> . The issuer field of the authdatum element is returned in <em>issuer</em> , and the unwrapped list of authdata is returned in <em>authdata</em> .</p> -</div> +</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_verify_authdata_kdc_issued - Unwrap and verify AD-KDCIssued authorization data.</a></li> @@ -133,6 +122,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_verify_checksum.html b/doc/html/appdev/refs/api/krb5_verify_checksum.html index f402465fd2b9..aaca4728212c 100644 --- a/doc/html/appdev/refs/api/krb5_verify_checksum.html +++ b/doc/html/appdev/refs/api/krb5_verify_checksum.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_verify_checksum — 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 types and structures" href="../types/index.html" /> <link rel="prev" title="krb5_use_enctype" href="krb5_use_enctype.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,37 +52,35 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-verify-checksum"> + <section id="krb5-verify-checksum"> <h1>krb5_verify_checksum<a class="headerlink" href="#krb5-verify-checksum" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_verify_checksum"> -<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_verify_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype">krb5_cksumtype</a><em> ctype</em>, const <a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum">krb5_checksum</a> *<em> cksum</em>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> in</em>, size_t<em> in_length</em>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer">krb5_const_pointer</a><em> seed</em>, size_t<em> seed_length</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_checksum" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_verify_checksum"> +<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_verify_checksum</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>, <a class="reference internal" href="../types/krb5_cksumtype.html#c.krb5_cksumtype" title="krb5_cksumtype"><span class="n"><span class="pre">krb5_cksumtype</span></span></a><span class="w"> </span><span class="n"><span class="pre">ctype</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><a class="reference internal" href="../types/krb5_checksum.html#c.krb5_checksum" title="krb5_checksum"><span class="n"><span class="pre">krb5_checksum</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">cksum</span></span>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">in</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">in_length</span></span>, <a class="reference internal" href="../types/krb5_const_pointer.html#c.krb5_const_pointer" title="krb5_const_pointer"><span class="n"><span class="pre">krb5_const_pointer</span></span></a><span class="w"> </span><span class="n"><span class="pre">seed</span></span>, <span class="n"><span class="pre">size_t</span></span><span class="w"> </span><span class="n"><span class="pre">seed_length</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_checksum" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>context</strong></p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>context</strong></p> <p><strong>ctype</strong></p> <p><strong>cksum</strong></p> <p><strong>in</strong></p> <p><strong>in_length</strong></p> <p><strong>seed</strong></p> -<p class="last"><strong>seed_length</strong></p> -</td> -</tr> -</tbody> -</table> +<p><strong>seed_length</strong></p> +</dd> +</dl> <p>DEPRECATED See krb5_c_verify_checksum()</p> -</div> +</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_verify_checksum</a></li> @@ -135,6 +124,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -142,8 +132,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_verify_init_creds.html b/doc/html/appdev/refs/api/krb5_verify_init_creds.html index 58b2a1aae6ab..7f705b7b572c 100644 --- a/doc/html/appdev/refs/api/krb5_verify_init_creds.html +++ b/doc/html/appdev/refs/api/krb5_verify_init_creds.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_verify_init_creds - Verify initial credentials against a keytab. — 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_verify_init_creds_opt_init - Initialize a credential verification options structure." href="krb5_verify_init_creds_opt_init.html" /> <link rel="prev" title="krb5_unmarshal_credentials - Deserialize a krb5_creds object." href="krb5_unmarshal_credentials.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,49 +52,43 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-verify-init-creds-verify-initial-credentials-against-a-keytab"> + <section id="krb5-verify-init-creds-verify-initial-credentials-against-a-keytab"> <h1>krb5_verify_init_creds - Verify initial credentials against a keytab.<a class="headerlink" href="#krb5-verify-init-creds-verify-initial-credentials-against-a-keytab" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_verify_init_creds"> -<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_verify_init_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds">krb5_creds</a> *<em> creds</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a><em> server</em>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab">krb5_keytab</a><em> keytab</em>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache">krb5_ccache</a> *<em> ccache</em>, <a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt">krb5_verify_init_creds_opt</a> *<em> options</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_verify_init_creds"> +<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_verify_init_creds</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>, <a class="reference internal" href="../types/krb5_creds.html#c.krb5_creds" title="krb5_creds"><span class="n"><span class="pre">krb5_creds</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">creds</span></span>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><span class="n"><span class="pre">krb5_principal</span></span></a><span class="w"> </span><span class="n"><span class="pre">server</span></span>, <a class="reference internal" href="../types/krb5_keytab.html#c.krb5_keytab" title="krb5_keytab"><span class="n"><span class="pre">krb5_keytab</span></span></a><span class="w"> </span><span class="n"><span class="pre">keytab</span></span>, <a class="reference internal" href="../types/krb5_ccache.html#c.krb5_ccache" title="krb5_ccache"><span class="n"><span class="pre">krb5_ccache</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">ccache</span></span>, <a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt"><span class="n"><span class="pre">krb5_verify_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>creds</strong> - Initial credentials to be verified</p> <p><strong>[in]</strong> <strong>server</strong> - Server principal (or NULL)</p> <p><strong>[in]</strong> <strong>keytab</strong> - Key table (NULL to use default keytab)</p> <p><strong>[in]</strong> <strong>ccache</strong> - Credential cache for fetched creds (or NULL)</p> -<p class="last"><strong>[in]</strong> <strong>options</strong> - Verification options (NULL for default options)</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>options</strong> - Verification options (NULL for default options)</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 attempts to verify that <em>creds</em> were obtained from a KDC with knowledge of a key in <em>keytab</em> , or the default keytab if <em>keytab</em> is NULL. If <em>server</em> is provided, the highest-kvno key entry for that principal name is used to verify the credentials; otherwise, all unique”host”service principals in the keytab are tried.</p> -<p>If the specified keytab does not exist, or is empty, or cannot be read, or does not contain an entry for <em>server</em> , then credential verification may be skipped unless configuration demands that it succeed. The caller can control this behavior by providing a verification options structure; see <a class="reference internal" href="krb5_verify_init_creds_opt_init.html#c.krb5_verify_init_creds_opt_init" title="krb5_verify_init_creds_opt_init"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds_opt_init()</span></code></a> and <a class="reference internal" href="krb5_verify_init_creds_opt_set_ap_req_nofail.html#c.krb5_verify_init_creds_opt_set_ap_req_nofail" title="krb5_verify_init_creds_opt_set_ap_req_nofail"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds_opt_set_ap_req_nofail()</span></code></a> .</p> +<p>If the specified keytab does not exist, or is empty, or cannot be read, or does not contain an entry for <em>server</em> , then credential verification may be skipped unless configuration demands that it succeed. The caller can control this behavior by providing a verification options structure; see krb5_verify_init_creds_opt_init() and krb5_verify_init_creds_opt_set_ap_req_nofail().</p> <p>If <em>ccache</em> is NULL, any additional credentials fetched during the verification process will be destroyed. If <em>ccache</em> points to NULL, a memory ccache will be created for the additional credentials and returned in <em>ccache</em> . If <em>ccache</em> points to a valid credential cache handle, the additional credentials will be stored in that cache.</p> -</div> +</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_verify_init_creds - Verify initial credentials against a keytab.</a></li> @@ -147,6 +132,7 @@ <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -154,8 +140,8 @@ <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_init.html b/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_init.html index 12ff7da6f27f..cc8493961f0b 100644 --- a/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_init.html +++ b/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_init.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_verify_init_creds_opt_init - Initialize a credential verification options structure. — 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_verify_init_creds_opt_set_ap_req_nofail - Set whether credential verification is required." href="krb5_verify_init_creds_opt_set_ap_req_nofail.html" /> <link rel="prev" title="krb5_verify_init_creds - Verify initial credentials against a keytab." href="krb5_verify_init_creds.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,29 +52,28 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-verify-init-creds-opt-init-initialize-a-credential-verification-options-structure"> + <section id="krb5-verify-init-creds-opt-init-initialize-a-credential-verification-options-structure"> <h1>krb5_verify_init_creds_opt_init - Initialize a credential verification options structure.<a class="headerlink" href="#krb5-verify-init-creds-opt-init-initialize-a-credential-verification-options-structure" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_verify_init_creds_opt_init"> -void <code class="descname">krb5_verify_init_creds_opt_init</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt">krb5_verify_init_creds_opt</a> *<em> k5_vic_options</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds_opt_init" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_verify_init_creds_opt_init"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_verify_init_creds_opt_init</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt"><span class="n"><span class="pre">krb5_verify_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">k5_vic_options</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds_opt_init" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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"><strong>[in]</strong> <strong>k5_vic_options</strong> - Verification options structure</td> -</tr> -</tbody> -</table> -</div> +<dl class="field-list simple"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>k5_vic_options</strong> - Verification options structure</p> +</dd> +</dl> +</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_verify_init_creds_opt_init - Initialize a credential verification options structure.</a></li> @@ -127,6 +117,7 @@ void <code class="descname">krb5_verify_init_creds_opt_init</code><span class="s <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -134,8 +125,8 @@ void <code class="descname">krb5_verify_init_creds_opt_init</code><span class="s <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_set_ap_req_nofail.html b/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_set_ap_req_nofail.html index 33badf65e778..e126c5b73141 100644 --- a/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_set_ap_req_nofail.html +++ b/doc/html/appdev/refs/api/krb5_verify_init_creds_opt_set_ap_req_nofail.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_verify_init_creds_opt_set_ap_req_nofail - Set whether credential verification is required. — 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_vprepend_error_message - Add a prefix to the message for an error code using a va_list." href="krb5_vprepend_error_message.html" /> <link rel="prev" title="krb5_verify_init_creds_opt_init - Initialize a credential verification options structure." href="krb5_verify_init_creds_opt_init.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-verify-init-creds-opt-set-ap-req-nofail-set-whether-credential-verification-is-required"> + <section id="krb5-verify-init-creds-opt-set-ap-req-nofail-set-whether-credential-verification-is-required"> <h1>krb5_verify_init_creds_opt_set_ap_req_nofail - Set whether credential verification is required.<a class="headerlink" href="#krb5-verify-init-creds-opt-set-ap-req-nofail-set-whether-credential-verification-is-required" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_verify_init_creds_opt_set_ap_req_nofail"> -void <code class="descname">krb5_verify_init_creds_opt_set_ap_req_nofail</code><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt">krb5_verify_init_creds_opt</a> *<em> k5_vic_options</em>, int<em> ap_req_nofail</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds_opt_set_ap_req_nofail" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_verify_init_creds_opt_set_ap_req_nofail"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_verify_init_creds_opt_set_ap_req_nofail</span></span></span><span class="sig-paren">(</span><a class="reference internal" href="../types/krb5_verify_init_creds_opt.html#c.krb5_verify_init_creds_opt" title="krb5_verify_init_creds_opt"><span class="n"><span class="pre">krb5_verify_init_creds_opt</span></span></a><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">k5_vic_options</span></span>, <span class="kt"><span class="pre">int</span></span><span class="w"> </span><span class="n"><span class="pre">ap_req_nofail</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_verify_init_creds_opt_set_ap_req_nofail" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>k5_vic_options</strong> - Verification options structure</p> -<p class="last"><strong>[in]</strong> <strong>ap_req_nofail</strong> - Whether to require successful verification</p> -</td> -</tr> -</tbody> -</table> -<p>This function determines how <a class="reference internal" href="krb5_verify_init_creds.html#c.krb5_verify_init_creds" title="krb5_verify_init_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds()</span></code></a> behaves if no keytab information is available. If <em>ap_req_nofail</em> is <strong>FALSE</strong> , verification will be skipped in this case and <a class="reference internal" href="krb5_verify_init_creds.html#c.krb5_verify_init_creds" title="krb5_verify_init_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds()</span></code></a> will return successfully. If <em>ap_req_nofail</em> is <strong>TRUE</strong> , <a class="reference internal" href="krb5_verify_init_creds.html#c.krb5_verify_init_creds" title="krb5_verify_init_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds()</span></code></a> will not return successfully unless verification can be performed.</p> -<p>If this function is not used, the behavior of <a class="reference internal" href="krb5_verify_init_creds.html#c.krb5_verify_init_creds" title="krb5_verify_init_creds"><code class="xref c c-func docutils literal"><span class="pre">krb5_verify_init_creds()</span></code></a> is determined through configuration.</p> -</div> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>k5_vic_options</strong> - Verification options structure</p> +<p><strong>[in]</strong> <strong>ap_req_nofail</strong> - Whether to require successful verification</p> +</dd> +</dl> +<p>This function determines how krb5_verify_init_creds() behaves if no keytab information is available. If <em>ap_req_nofail</em> is <strong>FALSE</strong> , verification will be skipped in this case and krb5_verify_init_creds() will return successfully. If <em>ap_req_nofail</em> is <strong>TRUE</strong> , krb5_verify_init_creds() will not return successfully unless verification can be performed.</p> +<p>If this function is not used, the behavior of krb5_verify_init_creds() is determined through configuration.</p> +</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_verify_init_creds_opt_set_ap_req_nofail - Set whether credential verification is required.</a></li> @@ -131,6 +120,7 @@ void <code class="descname">krb5_verify_init_creds_opt_set_ap_req_nofail</code>< <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ void <code class="descname">krb5_verify_init_creds_opt_set_ap_req_nofail</code>< <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_vprepend_error_message.html b/doc/html/appdev/refs/api/krb5_vprepend_error_message.html index fb66305024e6..94277fe36cbc 100644 --- a/doc/html/appdev/refs/api/krb5_vprepend_error_message.html +++ b/doc/html/appdev/refs/api/krb5_vprepend_error_message.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_vprepend_error_message - Add a prefix to the message for an error code using a va_list. — 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_vset_error_message - Set an extended error message for an error code using a va_list." href="krb5_vset_error_message.html" /> <link rel="prev" title="krb5_verify_init_creds_opt_set_ap_req_nofail - Set whether credential verification is required." href="krb5_verify_init_creds_opt_set_ap_req_nofail.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-vprepend-error-message-add-a-prefix-to-the-message-for-an-error-code-using-a-va-list"> + <section id="krb5-vprepend-error-message-add-a-prefix-to-the-message-for-an-error-code-using-a-va-list"> <h1>krb5_vprepend_error_message - Add a prefix to the message for an error code using a va_list.<a class="headerlink" href="#krb5-vprepend-error-message-add-a-prefix-to-the-message-for-an-error-code-using-a-va-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_vprepend_error_message"> -void <code class="descname">krb5_vprepend_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, va_list<em> args</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vprepend_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_vprepend_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_vprepend_error_message</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">ctx</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">args</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vprepend_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> <p><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> -<p class="last"><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> -</td> -</tr> -</tbody> -</table> -<p>This function is similar to <a class="reference internal" href="krb5_prepend_error_message.html#c.krb5_prepend_error_message" title="krb5_prepend_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_prepend_error_message()</span></code></a> , but uses a va_list instead of variadic arguments.</p> -</div> +<p><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> +</dd> +</dl> +<p>This function is similar to krb5_prepend_error_message(), but uses a va_list instead of variadic arguments.</p> +</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_vprepend_error_message - Add a prefix to the message for an error code using a va_list.</a></li> @@ -132,6 +121,7 @@ void <code class="descname">krb5_vprepend_error_message</code><span class="sig-p <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ void <code class="descname">krb5_vprepend_error_message</code><span class="sig-p <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_vset_error_message.html b/doc/html/appdev/refs/api/krb5_vset_error_message.html index 12b9467daa93..f53ce2d3b402 100644 --- a/doc/html/appdev/refs/api/krb5_vset_error_message.html +++ b/doc/html/appdev/refs/api/krb5_vset_error_message.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_vset_error_message - Set an extended error message for an error code using a va_list. — 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_vwrap_error_message - Add a prefix to a different error code’s message using a va_list." href="krb5_vwrap_error_message.html" /> <link rel="prev" title="krb5_vprepend_error_message - Add a prefix to the message for an error code using a va_list." href="krb5_vprepend_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,33 +52,31 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-vset-error-message-set-an-extended-error-message-for-an-error-code-using-a-va-list"> + <section id="krb5-vset-error-message-set-an-extended-error-message-for-an-error-code-using-a-va-list"> <h1>krb5_vset_error_message - Set an extended error message for an error code using a va_list.<a class="headerlink" href="#krb5-vset-error-message-set-an-extended-error-message-for-an-error-code-using-a-va-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_vset_error_message"> -void <code class="descname">krb5_vset_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, va_list<em> args</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vset_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_vset_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_vset_error_message</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">ctx</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">args</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vset_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> <p><strong>[in]</strong> <strong>fmt</strong> - Error string for the error code</p> -<p class="last"><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> -</td> -</tr> -</tbody> -</table> -</div> +<p><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> +</dd> +</dl> +</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_vset_error_message - Set an extended error message for an error code using a va_list.</a></li> @@ -131,6 +120,7 @@ void <code class="descname">krb5_vset_error_message</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -138,8 +128,8 @@ void <code class="descname">krb5_vset_error_message</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_vwrap_error_message.html b/doc/html/appdev/refs/api/krb5_vwrap_error_message.html index af02430aafa9..0609d8f7cbfb 100644 --- a/doc/html/appdev/refs/api/krb5_vwrap_error_message.html +++ b/doc/html/appdev/refs/api/krb5_vwrap_error_message.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_vwrap_error_message - Add a prefix to a different error code’s message using a va_list. — 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_wrap_error_message - Add a prefix to a different error code’s message." href="krb5_wrap_error_message.html" /> <link rel="prev" title="krb5_vset_error_message - Set an extended error message for an error code using a va_list." href="krb5_vset_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,35 +52,33 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-vwrap-error-message-add-a-prefix-to-a-different-error-code-s-message-using-a-va-list"> + <section id="krb5-vwrap-error-message-add-a-prefix-to-a-different-error-code-s-message-using-a-va-list"> <h1>krb5_vwrap_error_message - Add a prefix to a different error code’s message using a va_list.<a class="headerlink" href="#krb5-vwrap-error-message-add-a-prefix-to-a-different-error-code-s-message-using-a-va-list" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_vwrap_error_message"> -void <code class="descname">krb5_vwrap_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> old_code</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, va_list<em> args</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vwrap_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_vwrap_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_vwrap_error_message</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">ctx</span></span>, <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="n"><span class="pre">old_code</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="n"><span class="pre">va_list</span></span><span class="w"> </span><span class="n"><span class="pre">args</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_vwrap_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>old_code</strong> - Previous error code</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> <p><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> -<p class="last"><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> -</td> -</tr> -</tbody> -</table> -<p>This function is similar to <a class="reference internal" href="krb5_wrap_error_message.html#c.krb5_wrap_error_message" title="krb5_wrap_error_message"><code class="xref c c-func docutils literal"><span class="pre">krb5_wrap_error_message()</span></code></a> , but uses a va_list instead of variadic arguments.</p> -</div> +<p><strong>[in]</strong> <strong>args</strong> - List of vprintf(3) style arguments</p> +</dd> +</dl> +<p>This function is similar to krb5_wrap_error_message(), but uses a va_list instead of variadic arguments.</p> +</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_vwrap_error_message - Add a prefix to a different error code’s message using a va_list.</a></li> @@ -133,6 +122,7 @@ void <code class="descname">krb5_vwrap_error_message</code><span class="sig-pare <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -140,8 +130,8 @@ void <code class="descname">krb5_vwrap_error_message</code><span class="sig-pare <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> diff --git a/doc/html/appdev/refs/api/krb5_wrap_error_message.html b/doc/html/appdev/refs/api/krb5_wrap_error_message.html index df7f7ed2d4af..f0568ced4d6a 100644 --- a/doc/html/appdev/refs/api/krb5_wrap_error_message.html +++ b/doc/html/appdev/refs/api/krb5_wrap_error_message.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_wrap_error_message - Add a prefix to a different error code’s message. — 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_c_block_size - Return cipher block size." href="krb5_c_block_size.html" /> <link rel="prev" title="krb5_vwrap_error_message - Add a prefix to a different error code’s message using a va_list." href="krb5_vwrap_error_message.html" /> - </head> - <body> + </head><body> <div class="header-wrapper"> <div class="header"> @@ -61,34 +52,32 @@ <div class="bodywrapper"> <div class="body" role="main"> - <div class="section" id="krb5-wrap-error-message-add-a-prefix-to-a-different-error-code-s-message"> + <section id="krb5-wrap-error-message-add-a-prefix-to-a-different-error-code-s-message"> <h1>krb5_wrap_error_message - Add a prefix to a different error code’s message.<a class="headerlink" href="#krb5-wrap-error-message-add-a-prefix-to-a-different-error-code-s-message" title="Permalink to this headline">¶</a></h1> -<dl class="function"> -<dt id="c.krb5_wrap_error_message"> -void <code class="descname">krb5_wrap_error_message</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> ctx</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> old_code</em>, <a class="reference internal" href="../types/krb5_error_code.html#c.krb5_error_code" title="krb5_error_code">krb5_error_code</a><em> code</em>, const char *<em> fmt</em>, ...<span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_wrap_error_message" title="Permalink to this definition">¶</a></dt> +<dl class="c function"> +<dt class="sig sig-object c" id="c.krb5_wrap_error_message"> +<span class="kt"><span class="pre">void</span></span><span class="w"> </span><span class="sig-name descname"><span class="n"><span class="pre">krb5_wrap_error_message</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">ctx</span></span>, <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="n"><span class="pre">old_code</span></span>, <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="n"><span class="pre">code</span></span>, <span class="k"><span class="pre">const</span></span><span class="w"> </span><span class="kt"><span class="pre">char</span></span><span class="w"> </span><span class="p"><span class="pre">*</span></span><span class="n"><span class="pre">fmt</span></span>, <span class="p"><span class="pre">...</span></span><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_wrap_error_message" title="Permalink to this definition">¶</a><br /></dt> <dd></dd></dl> -<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>ctx</strong> - Library context</p> +<dl class="field-list"> +<dt class="field-odd">param</dt> +<dd class="field-odd"><p><strong>[in]</strong> <strong>ctx</strong> - Library context</p> <p><strong>[in]</strong> <strong>old_code</strong> - Previous error code</p> <p><strong>[in]</strong> <strong>code</strong> - Error code</p> -<p class="last"><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> -</td> -</tr> -</tbody> -</table> +<p><strong>[in]</strong> <strong>fmt</strong> - Format string for error message prefix</p> +</dd> +</dl> <p>Format a message and prepend it to the message for <em>old_code</em> . The prefix will be separated from the old message with a colon and space. Set the resulting message as the extended error message for <em>code</em> .</p> -</div> +</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_wrap_error_message - Add a prefix to a different error code’s message.</a></li> @@ -132,6 +121,7 @@ void <code class="descname">krb5_wrap_error_message</code><span class="sig-paren <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> + </div> <div class="clearer"></div> </div> @@ -139,8 +129,8 @@ void <code class="descname">krb5_wrap_error_message</code><span class="sig-paren <div class="footer-wrapper"> <div class="footer" > - <div class="right" ><i>Release: 1.21.2</i><br /> - © <a href="../../../copyright.html">Copyright</a> 1985-2023, MIT. + <div class="right" ><i>Release: 1.21.3</i><br /> + © <a href="../../../copyright.html">Copyright</a> 1985-2024, MIT. </div> <div class="left"> |