svn rev #25023: trunk/src/include/krb5/
tsitkova@MIT.EDU
tsitkova at MIT.EDU
Wed Jul 20 12:48:25 EDT 2011
http://src.mit.edu/fisheye/changelog/krb5/?cs=25023
Commit By: tsitkova
Log Message:
Added documentation for krb5_decode_authdata_container and krb5_encode_authdata_container API functions
Changed Files:
U trunk/src/include/krb5/krb5.hin
Modified: trunk/src/include/krb5/krb5.hin
===================================================================
--- trunk/src/include/krb5/krb5.hin 2011-07-20 05:12:10 UTC (rev 25022)
+++ trunk/src/include/krb5/krb5.hin 2011-07-20 16:48:25 UTC (rev 25023)
@@ -1643,7 +1643,7 @@
/** 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 @@
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,
More information about the cvs-krb5
mailing list