xref: /freebsd/crypto/heimdal/lib/krb5/krb5_parse_name.3 (revision b528cefc6b8f9670b31a865051741d946cb37085)
1.\" Copyright (c) 1997 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_parse_name.3,v 1.1 1997/08/14 00:03:17 joda Exp $
3.Dd August 8, 1997
4.Dt KRB5_PARSE_NAME 3
5.Os HEIMDAL
6.Sh NAME
7.Nm krb5_parse_name
8.Nd String to principal conversion
9
10.Sh SYNOPSIS
11.Fd #include <krb5.h>
12
13.Ft krb5_error_code
14.Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
15
16.Sh DESCRIPTION
17
18.Fn krb5_parse_name
19converts a string representation of a princpal name to
20.Nm krb5_principal .
21The
22.Fa principal
23will point to allocated data that should be freed with
24.Fn krb5_free_principal .
25.Pp
26The string should consist of one or more name components separated with slashes
27.Pq Dq / ,
28optionally followed with an
29.Dq @
30and a realm name. A slash or @ may be contained in a name component by
31quoting it with a back-slash
32.Pq Dq \ .
33A realm should not contain slashes or colons.
34.Sh SEE ALSO
35.Xr krb5_425_conv_principal 3 ,
36.Xr krb5_build_principal 3 ,
37.Xr krb5_free_principal 3 ,
38.Xr krb5_sname_to_principal 3 ,
39.Xr krb5_unparse_name 3
40