From ed511371f38e153af2eb444c165c585a983eee5d Mon Sep 17 00:00:00 2001 From: Zhanna Tsitkov Date: Wed, 20 Jul 2011 16:48:25 +0000 Subject: [PATCH] Added documentation for krb5_decode_authdata_container and krb5_encode_authdata_container API functions git-svn-id: svn://anonsvn.mit.edu/krb5/trunk@25023 dc483132-0cff-0310-8789-dd5450dbe970 --- src/include/krb5/krb5.hin | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/src/include/krb5/krb5.hin b/src/include/krb5/krb5.hin index 4b0cc8c76..c6a1ba2a4 100644 --- a/src/include/krb5/krb5.hin +++ b/src/include/krb5/krb5.hin @@ -1643,7 +1643,7 @@ krb5_verify_checksum(krb5_context context, krb5_cksumtype ctype, /** alternate authentication types */ #define KRB5_ALTAUTH_ATT_CHALLENGE_RESPONSE 64 -/* authorization data types */ +/* authorization data types. See RFC 4120 section 5.2.6 */ #define KRB5_AUTHDATA_IF_RELEVANT 1 #define KRB5_AUTHDATA_KDC_ISSUED 4 #define KRB5_AUTHDATA_AND_OR 5 @@ -6938,12 +6938,37 @@ krb5_free_error_message(krb5_context ctx, const char *msg); void KRB5_CALLCONV krb5_clear_error_message(krb5_context ctx); +/** + * Unwrap authorization data. + * + * @param [in] context Library context + * @param [in] type KRB5_AUTHDATA type of @a container + * @param [in] container Authorization data to be decoded + * @param [out] authdata List of decoded authorization data + * + * @sa krb5_encode_authdata_container() + * + * @retval 0 Success; otherwise - Kerberos error codes + */ krb5_error_code KRB5_CALLCONV krb5_decode_authdata_container(krb5_context context, krb5_authdatatype type, const krb5_authdata *container, krb5_authdata ***authdata); - +/** + * Wrap authorization data in a container. + * + * @param [in] context Library context + * @param [in] type KRB5_AUTHDATA type of @a container + * @param [in] authdata List of authorization data to be encoded + * @param [out] container List of encoded authorization data + * + * The result is returned in @a container as a single-element list. + * + * @sa krb5_decode_authdata_container() + * + * @retval 0 Success; otherwise - Kerberos error codes + */ krb5_error_code KRB5_CALLCONV krb5_encode_authdata_container(krb5_context context, krb5_authdatatype type, -- 2.26.2