| blob | 42e2491db179a7187b59b24b087243c8c3f24e37 |
1 .\" Copyright (c) 2003 - 2007 Kungliga Tekniska Högskolan
2 .\" (Royal Institute of Technology, Stockholm, Sweden).
3 .\" All rights reserved.
4 .\"
5 .\" Redistribution and use in source and binary forms, with or without
6 .\" modification, are permitted provided that the following conditions
7 .\" are met:
8 .\"
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\"
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
15 .\"
16 .\" 3. Neither the name of the Institute nor the names of its contributors
17 .\" may be used to endorse or promote products derived from this software
18 .\" without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE INSTITUTE AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE INSTITUTE OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\" $Heimdal: krb5_principal.3 21255 2007-06-21 04:36:31Z lha $
33 .\" $NetBSD$
34 .\"
35 .Dd May 1, 2006
36 .Dt KRB5_PRINCIPAL 3
37 .Os
38 .Sh NAME
39 .Nm krb5_get_default_principal ,
40 .Nm krb5_principal ,
41 .Nm krb5_build_principal ,
42 .Nm krb5_build_principal_ext ,
43 .Nm krb5_build_principal_va ,
44 .Nm krb5_build_principal_va_ext ,
45 .Nm krb5_copy_principal ,
46 .Nm krb5_free_principal ,
47 .Nm krb5_make_principal ,
48 .Nm krb5_parse_name ,
49 .Nm krb5_parse_name_flags ,
50 .Nm krb5_parse_nametype ,
51 .Nm krb5_princ_realm ,
52 .Nm krb5_princ_set_realm ,
53 .Nm krb5_principal_compare ,
54 .Nm krb5_principal_compare_any_realm ,
55 .Nm krb5_principal_get_comp_string ,
56 .Nm krb5_principal_get_realm ,
57 .Nm krb5_principal_get_type ,
58 .Nm krb5_principal_match ,
59 .Nm krb5_principal_set_type ,
60 .Nm krb5_realm_compare ,
61 .Nm krb5_sname_to_principal ,
62 .Nm krb5_sock_to_principal ,
63 .Nm krb5_unparse_name ,
64 .Nm krb5_unparse_name_flags ,
65 .Nm krb5_unparse_name_fixed ,
66 .Nm krb5_unparse_name_fixed_flags ,
67 .Nm krb5_unparse_name_fixed_short ,
68 .Nm krb5_unparse_name_short
69 .Nd Kerberos 5 principal handling functions
70 .Sh LIBRARY
71 Kerberos 5 Library (libkrb5, -lkrb5)
72 .Sh SYNOPSIS
73 .In krb5/krb5.h
74 .Pp
75 .Li krb5_principal ;
76 .Ft void
77 .Fn krb5_free_principal "krb5_context context" "krb5_principal principal"
78 .Ft krb5_error_code
79 .Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
80 .Ft krb5_error_code
81 .Fn krb5_parse_name_flags "krb5_context context" "const char *name" "int flags" "krb5_principal *principal"
82 .Ft krb5_error_code
83 .Fn "krb5_unparse_name" "krb5_context context" "krb5_const_principal principal" "char **name"
84 .Ft krb5_error_code
85 .Fn "krb5_unparse_name_flags" "krb5_context context" "krb5_const_principal principal" "int flags" "char **name"
86 .Ft krb5_error_code
87 .Fn krb5_unparse_name_fixed "krb5_context context" "krb5_const_principal principal" "char *name" "size_t len"
88 .Ft krb5_error_code
89 .Fn krb5_unparse_name_fixed_flags "krb5_context context" "krb5_const_principal principal" "int flags" "char *name" "size_t len"
90 .Ft krb5_error_code
91 .Fn "krb5_unparse_name_short" "krb5_context context" "krb5_const_principal principal" "char **name"
92 .Ft krb5_error_code
93 .Fn krb5_unparse_name_fixed_short "krb5_context context" "krb5_const_principal principal" "char *name" "size_t len"
94 .Ft krb5_realm *
95 .Fn krb5_princ_realm "krb5_context context" "krb5_principal principal"
96 .Ft void
97 .Fn krb5_princ_set_realm "krb5_context context" "krb5_principal principal" "krb5_realm *realm"
98 .Ft krb5_error_code
99 .Fn krb5_build_principal "krb5_context context" "krb5_principal *principal" "int rlen" "krb5_const_realm realm" "..."
100 .Ft krb5_error_code
101 .Fn krb5_build_principal_va "krb5_context context" "krb5_principal *principal" "int rlen" "krb5_const_realm realm" "va_list ap"
102 .Ft krb5_error_code
103 .Fn "krb5_build_principal_ext" "krb5_context context" "krb5_principal *principal" "int rlen" "krb5_const_realm realm" "..."
104 .Ft krb5_error_code
105 .Fn krb5_build_principal_va_ext "krb5_context context" "krb5_principal *principal" "int rlen" "krb5_const_realm realm" "va_list ap"
106 .Ft krb5_error_code
107 .Fn krb5_make_principal "krb5_context context" "krb5_principal *principal" "krb5_const_realm realm" "..."
108 .Ft krb5_error_code
109 .Fn krb5_copy_principal "krb5_context context" "krb5_const_principal inprinc" "krb5_principal *outprinc"
110 .Ft krb5_boolean
111 .Fn krb5_principal_compare "krb5_context context" "krb5_const_principal princ1" "krb5_const_principal princ2"
112 .Ft krb5_boolean
113 .Fn krb5_principal_compare_any_realm "krb5_context context" "krb5_const_principal princ1" "krb5_const_principal princ2"
114 .Ft "const char *"
115 .Fn krb5_principal_get_comp_string "krb5_context context" "krb5_const_principal principal" "unsigned int component"
116 .Ft "const char *"
117 .Fn krb5_principal_get_realm "krb5_context context" "krb5_const_principal principal"
118 .Ft int
119 .Fn krb5_principal_get_type "krb5_context context" "krb5_const_principal principal"
120 .Ft krb5_boolean
121 .Fn krb5_principal_match "krb5_context context" "krb5_const_principal principal" "krb5_const_principal pattern"
122 .Ft void
123 .Fn krb5_principal_set_type "krb5_context context" "krb5_principal principal" "int type"
124 .Ft krb5_boolean
125 .Fn krb5_realm_compare "krb5_context context" "krb5_const_principal princ1" "krb5_const_principal princ2"
126 .Ft krb5_error_code
127 .Fn krb5_sname_to_principal "krb5_context context" "const char *hostname" "const char *sname" "int32_t type" "krb5_principal *ret_princ"
128 .Ft krb5_error_code
129 .Fn krb5_sock_to_principal "krb5_context context" "int socket" "const char *sname" "int32_t type" "krb5_principal *principal"
130 .Ft krb5_error_code
131 .Fn krb5_get_default_principal "krb5_context context" "krb5_principal *princ"
132 .Ft krb5_error_code
133 .Fn krb5_parse_nametype "krb5_context context" "const char *str" "int32_t *type"
134 .Sh DESCRIPTION
135 .Li krb5_principal
136 holds the name of a user or service in Kerberos.
137 .Pp
138 A principal has two parts, a
139 .Li PrincipalName
140 and a
141 .Li realm .
142 The PrincipalName consists of one or more components. In printed form,
143 the components are separated by /.
144 The PrincipalName also has a name-type.
145 .Pp
146 Examples of a principal are
147 .Li nisse/root@EXAMPLE.COM
148 and
149 .Li host/datan.kth.se@KTH.SE .
150 .Fn krb5_parse_name
151 and
152 .Fn krb5_parse_name_flags
153 passes a principal name in
154 .Fa name
155 to the kerberos principal structure.
156 .Fn krb5_parse_name_flags
157 takes an extra
158 .Fa flags
159 argument the following flags can be passed in
160 .Bl -tag -width Ds
161 .It Dv KRB5_PRINCIPAL_PARSE_NO_REALM
162 requries the input string to be without a realm, and no realm is
163 stored in the
164 .Fa principal
165 return argument.
166 .It Dv KRB5_PRINCIPAL_PARSE_MUST_REALM
167 requries the input string to with a realm.
168 .El
169 .Pp
170 .Fn krb5_unparse_name
171 and
172 .Fn krb5_unparse_name_flags
173 prints the principal
174 .Fa princ
175 to the string
176 .Fa name .
177 .Fa name
178 should be freed with
179 .Xr free 3 .
180 To the
181 .Fa flags
182 argument the following flags can be passed in
183 .Bl -tag -width Ds
184 .It Dv KRB5_PRINCIPAL_UNPARSE_SHORT
185 no realm if the realm is one of the local realms.
186 .It Dv KRB5_PRINCIPAL_UNPARSE_NO_REALM
187 never include any realm in the principal name.
188 .It Dv KRB5_PRINCIPAL_UNPARSE_DISPLAY
189 don't quote
190 .El
191 On failure
192 .Fa name
193 is set to
194 .Dv NULL .
195 .Fn krb5_unparse_name_fixed
196 and
197 .Fn krb5_unparse_name_fixed_flags
198 behaves just like
199 .Fn krb5_unparse ,
200 but instead unparses the principal into a fixed size buffer.
201 .Pp
202 .Fn krb5_unparse_name_short
203 just returns the principal without the realm if the principal is
204 in the default realm. If the principal isn't, the full name is
205 returned.
206 .Fn krb5_unparse_name_fixed_short
207 works just like
208 .Fn krb5_unparse_name_short
209 but on a fixed size buffer.
210 .Pp
211 .Fn krb5_build_principal
212 builds a principal from the realm
213 .Fa realm
214 that has the length
215 .Fa rlen .
216 The following arguments form the components of the principal.
217 The list of components is terminated with
218 .Dv NULL .
219 .Pp
220 .Fn krb5_build_principal_va
221 works like
222 .Fn krb5_build_principal
223 using vargs.
224 .Pp
225 .Fn krb5_build_principal_ext
226 and
227 .Fn krb5_build_principal_va_ext
228 take a list of length-value pairs, the list is terminated with a zero
229 length.
230 .Pp
231 .Fn krb5_make_principal
232 works the same way as
233 .Fn krb5_build_principal ,
234 except it figures out the length of the realm itself.
235 .Pp
236 .Fn krb5_copy_principal
237 makes a copy of a principal.
238 The copy needs to be freed with
239 .Fn krb5_free_principal .
240 .Pp
241 .Fn krb5_principal_compare
242 compares the two principals, including realm of the principals and returns
243 .Dv TRUE
244 if they are the same and
245 .Dv FALSE
246 if not.
247 .Pp
248 .Fn krb5_principal_compare_any_realm
249 works the same way as
250 .Fn krb5_principal_compare
251 but doesn't compare the realm component of the principal.
252 .Pp
253 .Fn krb5_realm_compare
254 compares the realms of the two principals and returns
255 .Dv TRUE
256 is they are the same, and
257 .Dv FALSE
258 if not.
259 .Pp
260 .Fn krb5_principal_match
261 matches a
262 .Fa principal
263 against a
264 .Fa pattern .
265 The pattern is a globbing expression, where each component (separated
266 by /) is matched against the corresponding component of the principal.
267 .Pp
268 The
269 .Fn krb5_principal_get_realm
270 and
271 .Fn krb5_principal_get_comp_string
272 functions return parts of the
273 .Fa principal ,
274 either the realm or a specific component.
275 Both functions return string pointers to data inside the principal, so
276 they are valid only as long as the principal exists.
277 .Pp
278 The
279 .Fa component
280 argument to
281 .Fn krb5_principal_get_comp_string
282 is the index of the component to return, from zero to the total number of
283 components minus one. If the index is out of range
284 .Dv NULL
285 is returned.
286 .Pp
287 .Fn krb5_principal_get_realm
288 and
289 .Fn krb5_principal_get_comp_string
290 are replacements for
291 .Fn krb5_princ_realm ,
292 .Fn krb5_princ_component
293 and related macros, described as internal in the MIT API
294 specification.
295 Unlike the macros, these functions return strings, not
296 .Dv krb5_data .
297 A reason to return
298 .Dv krb5_data
299 was that it was believed that principal components could contain
300 binary data, but this belief was unfounded, and it has been decided
301 that principal components are infact UTF8, so it's safe to use zero
302 terminated strings.
303 .Pp
304 It's generally not necessary to look at the components of a principal.
305 .Pp
306 .Fn krb5_principal_get_type
307 and
308 .Fn krb5_principal_set_type
309 get and sets the name type for a principal.
310 Name type handling is tricky and not often needed,
311 don't use this unless you know what you do.
312 .Pp
313 .Fn krb5_princ_realm
314 returns the realm component of the principal.
315 The caller must not free realm unless
316 .Fn krb5_princ_set_realm
317 is called to set a new realm after freeing the realm.
318 .Fn krb5_princ_set_realm
319 sets the realm component of a principal. The old realm is not freed.
320 .Pp
321 .Fn krb5_sname_to_principal
322 and
323 .Fn krb5_sock_to_principal
324 are for easy creation of
325 .Dq service
326 principals that can, for instance, be used to lookup a key in a keytab.
327 For both functions the
328 .Fa sname
329 parameter will be used for the first component of the created principal.
330 If
331 .Fa sname
332 is
333 .Dv NULL ,
334 .Dq host
335 will be used instead.
336 .Pp
337 .Fn krb5_sname_to_principal
338 will use the passed
339 .Fa hostname
340 for the second component.
341 If
342 .Fa type
343 is
344 .Dv KRB5_NT_SRV_HST
345 this name will be looked up with
346 .Fn gethostbyname .
347 If
348 .Fa hostname
349 is
350 .Dv NULL ,
351 the local hostname will be used.
352 .Pp
353 .Fn krb5_sock_to_principal
354 will use the
355 .Dq sockname
356 of the passed
357 .Fa socket ,
358 which should be a bound
359 .Dv AF_INET
360 or
361 .Dv AF_INET6
362 socket.
363 There must be a mapping between the address and
364 .Dq sockname .
365 The function may try to resolve the name in DNS.
366 .Pp
367 .Fn krb5_get_default_principal
368 tries to find out what's a reasonable default principal by looking at
369 the environment it is running in.
370 .Pp
371 .Fn krb5_parse_nametype
372 parses and returns the name type integer value in
373 .Fa type .
374 On failure the function returns an error code and set the error
375 string.
376 .\" .Sh EXAMPLES
377 .Sh SEE ALSO
378 .Xr krb5_425_conv_principal 3 ,
379 .Xr krb5_config 3 ,
380 .Xr krb5.conf 5
381 .Sh BUGS
382 You can not have a NUL in a component in some of the variable argument
383 functions above.
384 Until someone can give a good example of where it would be a good idea
385 to have NUL's in a component, this will not be fixed.