diff options
author | Andreas Schneider <asn@samba.org> | 2016-08-30 14:13:43 +0200 |
---|---|---|
committer | Andrew Bartlett <abartlet@samba.org> | 2016-08-31 20:59:17 +0200 |
commit | 591b8671464c4ee7bdc35fbd4fb51c5ed266af7b (patch) | |
tree | 3f9dcf1460e995014e431ce5b13abc2cc5deeb46 /lib/krb5_wrap | |
parent | 757e77b7faef936ebfd365362d151dbba907c0c3 (diff) | |
download | samba-591b8671464c4ee7bdc35fbd4fb51c5ed266af7b.tar.gz |
krb5_wrap: Improve smb_krb5_parse_name() documentation
Signed-off-by: Andreas Schneider <asn@samba.org>
Reviewed-by: Andrew Bartlett <abartlet@samba.org>
Diffstat (limited to 'lib/krb5_wrap')
-rw-r--r-- | lib/krb5_wrap/krb5_samba.c | 21 |
1 files changed, 15 insertions, 6 deletions
diff --git a/lib/krb5_wrap/krb5_samba.c b/lib/krb5_wrap/krb5_samba.c index d1ca958d8a7..0cd20e7d008 100644 --- a/lib/krb5_wrap/krb5_samba.c +++ b/lib/krb5_wrap/krb5_samba.c @@ -434,13 +434,22 @@ bool unwrap_edata_ntstatus(TALLOC_CTX *mem_ctx, } -/************************************************************** - krb5_parse_name that takes a UNIX charset. -**************************************************************/ - +/** + * @brief Convert a string principal name to a Kerberos principal. + * + * @param[in] context The library context + * + * @param[in] name The principal as a unix charset string. + * + * @param[out] principal The newly allocated principal. + * + * Use krb5_free_principal() to free a principal when it is no longer needed. + * + * @return 0 on success, a Kerberos error code otherwise. + */ krb5_error_code smb_krb5_parse_name(krb5_context context, - const char *name, /* in unix charset */ - krb5_principal *principal) + const char *name, + krb5_principal *principal) { krb5_error_code ret; char *utf8_name; |