[svn-commits] mmichelson: branch mmichelson/authenticate r381060 - /team/mmichelson/authent...

[SVN commits to the Digium repositories]

Author: mmichelson
Date: Thu Feb  7 14:53:36 2013
New Revision: 381060

URL: http://svnview.digium.com/svn/asterisk?view=rev&rev=381060
Log:
Add some doxygen to the challenge structure so it's a little clearer what its purpose is.


Modified:
    team/mmichelson/authenticate/res/res_sip_authenticator_digest.c

Modified: team/mmichelson/authenticate/res/res_sip_authenticator_digest.c
URL: http://svnview.digium.com/svn/asterisk/team/mmichelson/authenticate/res/res_sip_authenticator_digest.c?view=diff&rev=381060&r1=381059&r2=381060
==============================================================================
--- team/mmichelson/authenticate/res/res_sip_authenticator_digest.c (original)
+++ team/mmichelson/authenticate/res/res_sip_authenticator_digest.c Thu Feb  7 14:53:36 2013
@@ -43,9 +43,23 @@
 
 static int response_id_counter;
 
+/*!
+ * \brief data used to help match incoming credentials to an authentication challenge we sent
+ *
+ * This challenge represents a WWW-Authenticate header sent in a 401 response. Its keys are
+ * the nonce and the realm. Using these two items, we can be sure to find if incoming credentials
+ * match a challenge we sent
+ *
+ * The response_id is an integer that helps to identify which 401 response the challenge was sent
+ * on. Since we can send multiple authentication challenges in a single response, multiple
+ * challenges can have the same response_id.
+ */
 struct challenge {
+	/*! The nonce sent in the WWW-Authenticate header */
 	char nonce[AST_UUID_STR_LEN];
+	/*! The realm sent in the WWW-Authenticate header */
 	const char *realm;
+	/*! The response in which this challenge was sent */
 	unsigned int response_id;
 };