xref: /freebsd/crypto/heimdal/lib/krb5/krb5_parse_name.3 (revision 6990ffd8a95caaba6858ad44ff1b3157d1efba8f)
1.\" Copyright (c) 1997 Kungliga Tekniska H�gskolan
2.\" $Id: krb5_parse_name.3,v 1.3 2001/05/02 08:59:23 assar 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.Sh SYNOPSIS
10.Fd #include <krb5.h>
11.Ft krb5_error_code
12.Fn krb5_parse_name "krb5_context context" "const char *name" "krb5_principal *principal"
13.Sh DESCRIPTION
14.Fn krb5_parse_name
15converts a string representation of a princpal name to
16.Nm krb5_principal .
17The
18.Fa principal
19will point to allocated data that should be freed with
20.Fn krb5_free_principal .
21.Pp
22The string should consist of one or more name components separated with slashes
23.Pq Dq / ,
24optionally followed with an
25.Dq @
26and a realm name. A slash or @ may be contained in a name component by
27quoting it with a back-slash
28.Pq Dq \ .
29A realm should not contain slashes or colons.
30.Sh SEE ALSO
31.Xr krb5_425_conv_principal 3 ,
32.Xr krb5_build_principal 3 ,
33.Xr krb5_free_principal 3 ,
34.Xr krb5_sname_to_principal 3 ,
35.Xr krb5_unparse_name 3
36