xref: /freebsd/crypto/krb5/doc/html/appdev/princ_handle.html (revision 7f2fe78b9dd5f51c821d771b63d2e096f6fd49e9)
1*7f2fe78bSCy Schubert
2*7f2fe78bSCy Schubert<!DOCTYPE html>
3*7f2fe78bSCy Schubert
4*7f2fe78bSCy Schubert<html>
5*7f2fe78bSCy Schubert  <head>
6*7f2fe78bSCy Schubert    <meta charset="utf-8" />
7*7f2fe78bSCy Schubert    <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
8*7f2fe78bSCy Schubert
9*7f2fe78bSCy Schubert    <title>Principal manipulation and parsing &#8212; MIT Kerberos Documentation</title>
10*7f2fe78bSCy Schubert    <link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
11*7f2fe78bSCy Schubert    <link rel="stylesheet" type="text/css" href="../_static/agogo.css" />
12*7f2fe78bSCy Schubert    <link rel="stylesheet" type="text/css" href="../_static/kerb.css" />
13*7f2fe78bSCy Schubert    <script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
14*7f2fe78bSCy Schubert    <script src="../_static/jquery.js"></script>
15*7f2fe78bSCy Schubert    <script src="../_static/underscore.js"></script>
16*7f2fe78bSCy Schubert    <script src="../_static/doctools.js"></script>
17*7f2fe78bSCy Schubert    <link rel="author" title="About these documents" href="../about.html" />
18*7f2fe78bSCy Schubert    <link rel="index" title="Index" href="../genindex.html" />
19*7f2fe78bSCy Schubert    <link rel="search" title="Search" href="../search.html" />
20*7f2fe78bSCy Schubert    <link rel="copyright" title="Copyright" href="../copyright.html" />
21*7f2fe78bSCy Schubert    <link rel="next" title="Complete reference - API and datatypes" href="refs/index.html" />
22*7f2fe78bSCy Schubert    <link rel="prev" title="Initial credentials" href="init_creds.html" />
23*7f2fe78bSCy Schubert  </head><body>
24*7f2fe78bSCy Schubert    <div class="header-wrapper">
25*7f2fe78bSCy Schubert        <div class="header">
26*7f2fe78bSCy Schubert
27*7f2fe78bSCy Schubert
28*7f2fe78bSCy Schubert            <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
29*7f2fe78bSCy Schubert
30*7f2fe78bSCy Schubert            <div class="rel">
31*7f2fe78bSCy Schubert
32*7f2fe78bSCy Schubert        <a href="../index.html" title="Full Table of Contents"
33*7f2fe78bSCy Schubert            accesskey="C">Contents</a> |
34*7f2fe78bSCy Schubert        <a href="init_creds.html" title="Initial credentials"
35*7f2fe78bSCy Schubert            accesskey="P">previous</a> |
36*7f2fe78bSCy Schubert        <a href="refs/index.html" title="Complete reference - API and datatypes"
37*7f2fe78bSCy Schubert            accesskey="N">next</a> |
38*7f2fe78bSCy Schubert        <a href="../genindex.html" title="General Index"
39*7f2fe78bSCy Schubert            accesskey="I">index</a> |
40*7f2fe78bSCy Schubert        <a href="../search.html" title="Enter search criteria"
41*7f2fe78bSCy Schubert            accesskey="S">Search</a> |
42*7f2fe78bSCy Schubert    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Principal manipulation and parsing">feedback</a>
43*7f2fe78bSCy Schubert            </div>
44*7f2fe78bSCy Schubert        </div>
45*7f2fe78bSCy Schubert    </div>
46*7f2fe78bSCy Schubert
47*7f2fe78bSCy Schubert    <div class="content-wrapper">
48*7f2fe78bSCy Schubert      <div class="content">
49*7f2fe78bSCy Schubert        <div class="document">
50*7f2fe78bSCy Schubert
51*7f2fe78bSCy Schubert      <div class="documentwrapper">
52*7f2fe78bSCy Schubert        <div class="bodywrapper">
53*7f2fe78bSCy Schubert          <div class="body" role="main">
54*7f2fe78bSCy Schubert
55*7f2fe78bSCy Schubert  <section id="principal-manipulation-and-parsing">
56*7f2fe78bSCy Schubert<h1>Principal manipulation and parsing<a class="headerlink" href="#principal-manipulation-and-parsing" title="Permalink to this headline">¶</a></h1>
57*7f2fe78bSCy Schubert<p>Kerberos principal structure</p>
58*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/types/krb5_principal_data.html#c.krb5_principal_data" title="krb5_principal_data"><code class="xref c c-type docutils literal notranslate"><span class="pre">krb5_principal_data</span></code></a></p>
59*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/types/krb5_principal.html#c.krb5_principal" title="krb5_principal"><code class="xref c c-type docutils literal notranslate"><span class="pre">krb5_principal</span></code></a></p>
60*7f2fe78bSCy Schubert<p>Create and free principal</p>
61*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_build_principal.html#c.krb5_build_principal" title="krb5_build_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_build_principal()</span></code></a></p>
62*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/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 notranslate"><span class="pre">krb5_build_principal_alloc_va()</span></code></a></p>
63*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_build_principal_ext.html#c.krb5_build_principal_ext" title="krb5_build_principal_ext"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_build_principal_ext()</span></code></a></p>
64*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_copy_principal.html#c.krb5_copy_principal" title="krb5_copy_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_copy_principal()</span></code></a></p>
65*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_free_principal.html#c.krb5_free_principal" title="krb5_free_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_free_principal()</span></code></a></p>
66*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_cc_get_principal.html#c.krb5_cc_get_principal" title="krb5_cc_get_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_cc_get_principal()</span></code></a></p>
67*7f2fe78bSCy Schubert<p>Comparing</p>
68*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_principal_compare.html#c.krb5_principal_compare" title="krb5_principal_compare"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_principal_compare()</span></code></a></p>
69*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_principal_compare_flags.html#c.krb5_principal_compare_flags" title="krb5_principal_compare_flags"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_principal_compare_flags()</span></code></a></p>
70*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_principal_compare_any_realm.html#c.krb5_principal_compare_any_realm" title="krb5_principal_compare_any_realm"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_principal_compare_any_realm()</span></code></a></p>
71*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_sname_match.html#c.krb5_sname_match" title="krb5_sname_match"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_sname_match()</span></code></a></p>
72*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_sname_to_principal.html#c.krb5_sname_to_principal" title="krb5_sname_to_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_sname_to_principal()</span></code></a></p>
73*7f2fe78bSCy Schubert<p>Parsing:</p>
74*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_parse_name.html#c.krb5_parse_name" title="krb5_parse_name"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_parse_name()</span></code></a></p>
75*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_parse_name_flags.html#c.krb5_parse_name_flags" title="krb5_parse_name_flags"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_parse_name_flags()</span></code></a></p>
76*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_unparse_name.html#c.krb5_unparse_name" title="krb5_unparse_name"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_unparse_name()</span></code></a></p>
77*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_unparse_name_flags.html#c.krb5_unparse_name_flags" title="krb5_unparse_name_flags"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_unparse_name_flags()</span></code></a></p>
78*7f2fe78bSCy Schubert<p>Utilities:</p>
79*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_is_config_principal.html#c.krb5_is_config_principal" title="krb5_is_config_principal"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_is_config_principal()</span></code></a></p>
80*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_kuserok.html#c.krb5_kuserok" title="krb5_kuserok"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_kuserok()</span></code></a></p>
81*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_set_password.html#c.krb5_set_password" title="krb5_set_password"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_set_password()</span></code></a></p>
82*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_set_password_using_ccache.html#c.krb5_set_password_using_ccache" title="krb5_set_password_using_ccache"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_set_password_using_ccache()</span></code></a></p>
83*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_set_principal_realm.html#c.krb5_set_principal_realm" title="krb5_set_principal_realm"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_set_principal_realm()</span></code></a></p>
84*7f2fe78bSCy Schubert<p><a class="reference internal" href="refs/api/krb5_realm_compare.html#c.krb5_realm_compare" title="krb5_realm_compare"><code class="xref c c-func docutils literal notranslate"><span class="pre">krb5_realm_compare()</span></code></a></p>
85*7f2fe78bSCy Schubert</section>
86*7f2fe78bSCy Schubert
87*7f2fe78bSCy Schubert
88*7f2fe78bSCy Schubert            <div class="clearer"></div>
89*7f2fe78bSCy Schubert          </div>
90*7f2fe78bSCy Schubert        </div>
91*7f2fe78bSCy Schubert      </div>
92*7f2fe78bSCy Schubert        </div>
93*7f2fe78bSCy Schubert        <div class="sidebar">
94*7f2fe78bSCy Schubert
95*7f2fe78bSCy Schubert    <h2>On this page</h2>
96*7f2fe78bSCy Schubert    <ul>
97*7f2fe78bSCy Schubert<li><a class="reference internal" href="#">Principal manipulation and parsing</a></li>
98*7f2fe78bSCy Schubert</ul>
99*7f2fe78bSCy Schubert
100*7f2fe78bSCy Schubert    <br/>
101*7f2fe78bSCy Schubert    <h2>Table of contents</h2>
102*7f2fe78bSCy Schubert    <ul class="current">
103*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
104*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../admin/index.html">For administrators</a></li>
105*7f2fe78bSCy Schubert<li class="toctree-l1 current"><a class="reference internal" href="index.html">For application developers</a><ul class="current">
106*7f2fe78bSCy Schubert<li class="toctree-l2"><a class="reference internal" href="gssapi.html">Developing with GSSAPI</a></li>
107*7f2fe78bSCy Schubert<li class="toctree-l2"><a class="reference internal" href="y2038.html">Year 2038 considerations for uses of krb5_timestamp</a></li>
108*7f2fe78bSCy Schubert<li class="toctree-l2"><a class="reference internal" href="h5l_mit_apidiff.html">Differences between Heimdal and MIT Kerberos API</a></li>
109*7f2fe78bSCy Schubert<li class="toctree-l2"><a class="reference internal" href="init_creds.html">Initial credentials</a></li>
110*7f2fe78bSCy Schubert<li class="toctree-l2 current"><a class="current reference internal" href="#">Principal manipulation and parsing</a></li>
111*7f2fe78bSCy Schubert<li class="toctree-l2"><a class="reference internal" href="refs/index.html">Complete reference - API and datatypes</a></li>
112*7f2fe78bSCy Schubert</ul>
113*7f2fe78bSCy Schubert</li>
114*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
115*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
116*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../basic/index.html">Kerberos V5 concepts</a></li>
117*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
118*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
119*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
120*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
121*7f2fe78bSCy Schubert<li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
122*7f2fe78bSCy Schubert</ul>
123*7f2fe78bSCy Schubert
124*7f2fe78bSCy Schubert    <br/>
125*7f2fe78bSCy Schubert    <h4><a href="../index.html">Full Table of Contents</a></h4>
126*7f2fe78bSCy Schubert    <h4>Search</h4>
127*7f2fe78bSCy Schubert    <form class="search" action="../search.html" method="get">
128*7f2fe78bSCy Schubert      <input type="text" name="q" size="18" />
129*7f2fe78bSCy Schubert      <input type="submit" value="Go" />
130*7f2fe78bSCy Schubert      <input type="hidden" name="check_keywords" value="yes" />
131*7f2fe78bSCy Schubert      <input type="hidden" name="area" value="default" />
132*7f2fe78bSCy Schubert    </form>
133*7f2fe78bSCy Schubert
134*7f2fe78bSCy Schubert        </div>
135*7f2fe78bSCy Schubert        <div class="clearer"></div>
136*7f2fe78bSCy Schubert      </div>
137*7f2fe78bSCy Schubert    </div>
138*7f2fe78bSCy Schubert
139*7f2fe78bSCy Schubert    <div class="footer-wrapper">
140*7f2fe78bSCy Schubert        <div class="footer" >
141*7f2fe78bSCy Schubert            <div class="right" ><i>Release: 1.21.3</i><br />
142*7f2fe78bSCy Schubert                &copy; <a href="../copyright.html">Copyright</a> 1985-2024, MIT.
143*7f2fe78bSCy Schubert            </div>
144*7f2fe78bSCy Schubert            <div class="left">
145*7f2fe78bSCy Schubert
146*7f2fe78bSCy Schubert        <a href="../index.html" title="Full Table of Contents"
147*7f2fe78bSCy Schubert            >Contents</a> |
148*7f2fe78bSCy Schubert        <a href="init_creds.html" title="Initial credentials"
149*7f2fe78bSCy Schubert            >previous</a> |
150*7f2fe78bSCy Schubert        <a href="refs/index.html" title="Complete reference - API and datatypes"
151*7f2fe78bSCy Schubert            >next</a> |
152*7f2fe78bSCy Schubert        <a href="../genindex.html" title="General Index"
153*7f2fe78bSCy Schubert            >index</a> |
154*7f2fe78bSCy Schubert        <a href="../search.html" title="Enter search criteria"
155*7f2fe78bSCy Schubert            >Search</a> |
156*7f2fe78bSCy Schubert    <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Principal manipulation and parsing">feedback</a>
157*7f2fe78bSCy Schubert            </div>
158*7f2fe78bSCy Schubert        </div>
159*7f2fe78bSCy Schubert    </div>
160*7f2fe78bSCy Schubert
161*7f2fe78bSCy Schubert  </body>
162*7f2fe78bSCy Schubert</html>