1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<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.12.1',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="author" title="About these documents" href="../../../about.html" />
<link rel="copyright" title="Copyright" href="../../../copyright.html" />
<link rel="top" title="MIT Kerberos Documentation" href="../../../index.html" />
<link rel="up" title="krb5 API" href="index.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>
<div class="header-wrapper">
<div class="header">
<h1><a href="../../../index.html">MIT Kerberos Documentation</a></h1>
<div class="rel">
<a href="../../../index.html" title="Full Table of Contents"
accesskey="C">Contents</a> |
<a href="krb5_parse_name.html" title="krb5_parse_name - Convert a string principal name to a krb5_principal structure."
accesskey="P">previous</a> |
<a href="krb5_principal_compare.html" title="krb5_principal_compare - Compare two principals."
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_parse_name_flags - Convert a string principal name to a krb5_principal with flags.">feedback</a>
</div>
</div>
</div>
<div class="content-wrapper">
<div class="content">
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="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="krb5_parse_name_flags">
<a class="reference internal" href="../types/krb5_error_code.html#krb5_error_code" title="krb5_error_code">krb5_error_code</a> <tt class="descname">krb5_parse_name_flags</tt><big>(</big><a class="reference internal" href="../types/krb5_context.html#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#krb5_principal" title="krb5_principal">krb5_principal</a> *<em> principal_out</em><big>)</big><a class="headerlink" href="#krb5_parse_name_flags" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>
<table class="docutils field-list" frame="void" rules="none">
<col class="field-name" />
<col class="field-body" />
<tbody valign="top">
<tr class="field-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>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>
</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>
</ul>
</td>
</tr>
</tbody>
</table>
<p>Similar to <a class="reference internal" href="krb5_parse_name.html#krb5_parse_name" title="krb5_parse_name"><tt class="xref c c-func docutils literal"><span class="pre">krb5_parse_name()</span></tt></a> , 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"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_NO_REALM</span></tt></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"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_REQUIRE_REALM</span></tt></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"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_ENTERPRISE</span></tt></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"><tt class="xref py py-data docutils literal"><span class="pre">KRB5_PRINCIPAL_PARSE_IGNORE_REALM</span></tt></a> - ignore realm if present in <em>name</em></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#krb5_free_principal" title="krb5_free_principal"><tt class="xref c c-func docutils literal"><span class="pre">krb5_free_principal()</span></tt></a> to free <em>principal_out</em> when it is no longer needed.</p>
</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>
</ul>
<br/>
<h2>Table of contents</h2>
<ul>
<li class="toctree-l1"><a class="reference internal" href="../../../user/index.html">For users</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../admin/index.html">For administrators</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../index.html">For application developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../plugindev/index.html">For plugin module developers</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build/index.html">Building Kerberos V5</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../basic/index.html">Kerberos V5 concepts</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../mitK5features.html">MIT Kerberos features</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../build_this.html">How to build this documentation from the source</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../about.html">Contributing to the MIT Kerberos Documentation</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../../resources.html">Resources</a></li>
</ul>
<br/>
<h4><a href="../../../index.html">Full Table of Contents</a></h4>
<h4>Search</h4>
<form class="search" action="../../../search.html" method="get">
<input type="text" name="q" size="18" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<div class="clearer"></div>
</div>
</div>
<div class="footer-wrapper">
<div class="footer" >
<div class="right" ><i>Release: 1.12.1</i><br />
© <a href="../../../copyright.html">Copyright</a> 1985-2013, MIT.
</div>
<div class="left">
<a href="../../../index.html" title="Full Table of Contents"
>Contents</a> |
<a href="krb5_parse_name.html" title="krb5_parse_name - Convert a string principal name to a krb5_principal structure."
>previous</a> |
<a href="krb5_principal_compare.html" title="krb5_principal_compare - Compare two principals."
>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_parse_name_flags - Convert a string principal name to a krb5_principal with flags.">feedback</a>
</div>
</div>
</div>
</body>
</html>
|
