File: krb5_parse_name.rst.txt

package info (click to toggle)
krb5 1.18.3-6%2Bdeb11u5
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 52,500 kB
  • sloc: ansic: 302,656; exp: 13,173; cpp: 9,693; python: 9,298; javascript: 9,118; makefile: 7,158; sh: 6,305; perl: 1,926; asm: 1,460; yacc: 1,005; awk: 396; csh: 147; xml: 135; lisp: 104; sed: 41
file content (74 lines) | stat: -rw-r--r-- 1,445 bytes parent folder | download | duplicates (3)
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
krb5_parse_name -  Convert a string principal name to a krb5_principal structure. 
==================================================================================

..

.. c:function:: krb5_error_code krb5_parse_name(krb5_context context, const char * name, krb5_principal * principal_out)

..


:param:

	          **[in]** **context** - Library context

	          **[in]** **name** - String representation of a principal name

	          **[out]** **principal_out** - New principal


..


:retval:
         -   0   Success


:return:
         -  Kerberos error codes 

..







Convert a string representation of a principal name to a krb5_principal structure.



A string representation of a Kerberos name consists of one or more principal name components, separated by slashes, optionally followed by the @ character and a realm name. If the realm name is not specified, the local realm is used.



To use the slash and @ symbols as part of a component (quoted) instead of using them as a component separator or as a realm prefix), put a backslash () character in front of the symbol. Similarly, newline, tab, backspace, and NULL characters can be included in a component by using **n** , **t** , **b** or **0** , respectively.



Use :c:func:`krb5_free_principal()` to free *principal_out* when it is no longer needed.










..






.. note::

	 The realm in a Kerberos *name* cannot contain slash, colon, or NULL characters.