doc/html/appdev/refs/api/krb5_parse_name.html

   1
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   3   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8     <title>krb5_parse_name - Convert a string principal name to a krb5_principal structure. &#8212; MIT Kerberos Documentation</title>
   9     <link rel="stylesheet" href="../../../_static/agogo.css" type="text/css" />
  10     <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
  11     <link rel="stylesheet" href="../../../_static/kerb.css" type="text/css" />
  12     <script type="text/javascript">
  13       var DOCUMENTATION_OPTIONS = {
  14         URL_ROOT:    '../../../',
  15         VERSION:     '1.20.1',
  16         COLLAPSE_INDEX: false,
  17         FILE_SUFFIX: '.html',
  18         HAS_SOURCE:  true,
  19         SOURCELINK_SUFFIX: '.txt'
  20       };
  21     </script>
  22     <script type="text/javascript" src="../../../_static/jquery.js"></script>
  23     <script type="text/javascript" src="../../../_static/underscore.js"></script>
  24     <script type="text/javascript" src="../../../_static/doctools.js"></script>
  25     <link rel="author" title="About these documents" href="../../../about.html" />
  26     <link rel="index" title="Index" href="../../../genindex.html" />
  27     <link rel="search" title="Search" href="../../../search.html" />
  28     <link rel="copyright" title="Copyright" href="../../../copyright.html" />
  29     <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" />
  30     <link rel="prev" title="krb5_kuserok - Determine if a principal is authorized to log in as a local user." href="krb5_kuserok.html" />
  31   </head>
  32   <body>
  33     <div class="header-wrapper">
  34         <div class="header">
  35
  36
  37             <h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
  38
  39             <div class="rel">
  40
  41         <a href="../../../index.html" title="Full Table of Contents"
  42             accesskey="C">Contents</a> |
  43         <a href="krb5_kuserok.html" title="krb5_kuserok - Determine if a principal is authorized to log in as a local user."
  44             accesskey="P">previous</a> |
  45         <a href="krb5_parse_name_flags.html" title="krb5_parse_name_flags - Convert a string principal name to a krb5_principal with flags."
  46             accesskey="N">next</a> |
  47         <a href="../../../genindex.html" title="General Index"
  48             accesskey="I">index</a> |
  49         <a href="../../../search.html" title="Enter search criteria"
  50             accesskey="S">Search</a> |
  51     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_parse_name -  Convert a string principal name to a krb5_principal structure.">feedback</a>
  52             </div>
  53         </div>
  54     </div>
  55
  56     <div class="content-wrapper">
  57       <div class="content">
  58         <div class="document">
  59
  60       <div class="documentwrapper">
  61         <div class="bodywrapper">
  62           <div class="body" role="main">
  63
  64   <div class="section" id="krb5-parse-name-convert-a-string-principal-name-to-a-krb5-principal-structure">
  65 <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>
  66 <dl class="function">
  67 <dt id="c.krb5_parse_name">
  68 <a class="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>&nbsp;context</em>, const char *<em>&nbsp;name</em>, <a class="reference internal" href="../types/krb5_principal.html#c.krb5_principal" title="krb5_principal">krb5_principal</a> *<em>&nbsp;principal_out</em><span class="sig-paren">)</span><a class="headerlink" href="#c.krb5_parse_name" title="Permalink to this definition">¶</a></dt>
  69 <dd></dd></dl>
  70
  71 <table class="docutils field-list" frame="void" rules="none">
  72 <col class="field-name" />
  73 <col class="field-body" />
  74 <tbody valign="top">
  75 <tr class="field-odd field"><th class="field-name">param:</th><td class="field-body"><p class="first"><strong>[in]</strong> <strong>context</strong> - Library context</p>
  76 <p><strong>[in]</strong> <strong>name</strong> - String representation of a principal name</p>
  77 <p class="last"><strong>[out]</strong> <strong>principal_out</strong> - New principal</p>
  78 </td>
  79 </tr>
  80 </tbody>
  81 </table>
  82 <table class="docutils field-list" frame="void" rules="none">
  83 <col class="field-name" />
  84 <col class="field-body" />
  85 <tbody valign="top">
  86 <tr class="field-odd field"><th class="field-name">retval:</th><td class="field-body"><ul class="first simple">
  87 <li>0   Success</li>
  88 </ul>
  89 </td>
  90 </tr>
  91 <tr class="field-even field"><th class="field-name">return:</th><td class="field-body"><ul class="first last simple">
  92 <li>Kerberos error codes</li>
  93 </ul>
  94 </td>
  95 </tr>
  96 </tbody>
  97 </table>
  98 <p>Convert a string representation of a principal name to a krb5_principal structure.</p>
  99 <p>A string representation of a Kerberos name consists of one or more principal name components, separated by slashes, optionally followed by the &#64; character and a realm name. If the realm name is not specified, the local realm is used.</p>
 100 <p>To use the slash and &#64; 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>
 101 <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>
 102 <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>
 103 <div class="admonition note">
 104 <p class="first admonition-title">Note</p>
 105 <p class="last">The realm in a Kerberos <em>name</em> cannot contain slash, colon, or NULL characters.</p>
 106 </div>
 107 </div>
 108
 109
 110           </div>
 111         </div>
 112       </div>
 113         </div>
 114         <div class="sidebar">
 115     <h2>On this page</h2>
 116     <ul>
 117 <li><a class="reference internal" href="#">krb5_parse_name -  Convert a string principal name to a krb5_principal structure.</a></li>
 118 </ul>
 119
 120     <br/>
 121     <h2>Table of contents</h2>
 122     <ul class="current">
 123 <li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
 124 <li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
 125 <li class="toctree-l1 current"><a class="reference internal" href="../../index.html">For application developers</a><ul class="current">
 126 <li class="toctree-l2"><a class="reference internal" href="../../gssapi.html">Developing with GSSAPI</a></li>
 127 <li class="toctree-l2"><a class="reference internal" href="../../y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
 128 <li class="toctree-l2"><a class="reference internal" href="../../h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
 129 <li class="toctree-l2"><a class="reference internal" href="../../init_creds.html">Initial credentials</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="../../princ_handle.html">Principal manipulation and parsing</a></li>
 131 <li class="toctree-l2 current"><a class="reference internal" href="../index.html">Complete reference - API and datatypes</a><ul class="current">
 132 <li class="toctree-l3 current"><a class="reference internal" href="index.html">krb5 API</a></li>
 133 <li class="toctree-l3"><a class="reference internal" href="../types/index.html">krb5 types and structures</a></li>
 134 <li class="toctree-l3"><a class="reference internal" href="../macros/index.html">krb5 simple macros</a></li>
 135 </ul>
 136 </li>
 137 </ul>
 138 </li>
 139 <li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
 140 <li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
 141 <li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
 142 <li class="toctree-l1"><a class="reference internal" href="../../../formats/index.html">Protocols and file formats</a></li>
 143 <li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
 144 <li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
 145 <li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 146 <li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
 147 </ul>
 148
 149     <br/>
 150     <h4><a href="../../../index.html">Full Table of Contents</a></h4>
 151     <h4>Search</h4>
 152     <form class="search" action="../../../search.html" method="get">
 153       <input type="text" name="q" size="18" />
 154       <input type="submit" value="Go" />
 155       <input type="hidden" name="check_keywords" value="yes" />
 156       <input type="hidden" name="area" value="default" />
 157     </form>
 158         </div>
 159         <div class="clearer"></div>
 160       </div>
 161     </div>
 162
 163     <div class="footer-wrapper">
 164         <div class="footer" >
 165             <div class="right" ><i>Release: 1.20.1</i><br />
 166                 &copy; <a href="../../../copyright.html">Copyright</a> 1985-2022, MIT.
 167             </div>
 168             <div class="left">
 169
 170         <a href="../../../index.html" title="Full Table of Contents"
 171             >Contents</a> |
 172         <a href="krb5_kuserok.html" title="krb5_kuserok - Determine if a principal is authorized to log in as a local user."
 173             >previous</a> |
 174         <a href="krb5_parse_name_flags.html" title="krb5_parse_name_flags - Convert a string principal name to a krb5_principal with flags."
 175             >next</a> |
 176         <a href="../../../genindex.html" title="General Index"
 177             >index</a> |
 178         <a href="../../../search.html" title="Enter search criteria"
 179             >Search</a> |
 180     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__krb5_parse_name -  Convert a string principal name to a krb5_principal structure.">feedback</a>
 181             </div>
 182         </div>
 183     </div>
 184
 185   </body>
 186 </html>