oysteikt/heimdal
0
0
Fork 0
Code Issues 5 Pull Requests Releases Activity

document krb5_principal_{get,set}_type

Browse Source 
git-svn-id: svn://svn.h5l.se/heimdal/trunk/heimdal@12950 ec53bebd-3082-4978-b11e-865c3cabbd6b
This commit is contained in:
Love Hörnquist Åstrand
2003-10-03 04:58:00 +00:00
parent 5e2f96156f
commit a358b88c42
1 changed files with 19 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
lib/krb5/krb5_principal.3
View File

@@ -31,7 +31,7 @@
.\"
.\" $Id$
.\"
.Dd April 16, 2003
.Dd October 3, 2003
.Dt KRB5_PRINCIPAL 3
.Os HEIMDAL
.Sh NAME
@@ -48,9 +48,11 @@
.Nm krb5_princ_set_realm ,
.Nm krb5_principal_compare ,
.Nm krb5_principal_compare_any_realm ,
.Nm krb5_principal_get_realm ,
.Nm krb5_principal_get_comp_string ,
.Nm krb5_principal_get_realm ,
.Nm krb5_principal_get_type ,
.Nm krb5_principal_match ,
.Nm krb5_principal_set_type ,
.Nm krb5_realm_compare ,
.Nm krb5_sname_to_principal ,
.Nm krb5_sock_to_principal ,
@@ -98,11 +100,15 @@ Kerberos 5 Library (libkrb5, -lkrb5)
.Ft krb5_boolean
.Fn krb5_principal_compare_any_realm "krb5_context context" "krb5_const_principal princ1 "krb5_const_principal princ2"
.Ft "const char *"
.Fn krb5_principal_get_realm "krb5_context context" "krb5_principal principal"
.Ft "const char *"
.Fn krb5_principal_get_comp_string "krb5_context context" "krb5_principal principal" "unsigned int component"
.Ft "const char *"
.Fn krb5_principal_get_realm "krb5_context context" "krb5_principal principal"
.Ft int
.Fn krb5_principal_get_type "krb5_context context" "krb5_principal principal"
.Ft krb5_boolean
.Fn krb5_principal_match "krb5_context context" "krb5_const_principal principal" "krb5_const_principal pattern"
.Ft void
.Fn krb5_principal_set_type "krb5_context context" "krb5_principal principal" "int type"
.Ft krb5_boolean
.Fn krb5_realm_compare "krb5_context context" "krb5_const_principal princ1" "krb5_const_principal princ2"
.Ft krb5_error_code
@@ -247,6 +253,13 @@ terminated strings.
.Pp
It's generally not necessary to look at the components of a principal.
.Pp
.Fn krb5_principal_get_type
and
.Fn krb5_principal_set_type
get and sets the name type for a principal.
Name type does exists but not really, there are subtile diffrences
when principal types are used and when they are not used.
.Pp
.Fn krb5_princ_realm
returns the realm component of the principal.
Caller must not free realm unless
@@ -304,6 +317,7 @@ This function might try to resolve the name in DNS.
.Xr krb5_config 3 ,
.Xr krb5.conf 5
.Sh BUGS
You can not have a NUL in a component in some of the variable argument function above.
You can not have a NUL in a component in some of the variable argument
function above.
Until someone can give a good example of where it would be a good idea
to have NUL's in a component, this will not be fixed.