diff options
Diffstat (limited to 'doc/html/appdev/refs/api/krb5_parse_name.html')
| -rw-r--r-- | doc/html/appdev/refs/api/krb5_parse_name.html | 98 |
1 files changed, 42 insertions, 56 deletions
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"> |