commit 5866b68fa7440cbbe39d1e06c310b3be8debf85e
parent 961635da2a9d7363528940f4fa7a0148e96e90d8
Author: Evgeny Grin (Karlson2k) <k2k@narod.ru>
Date: Thu, 21 Jul 2022 20:47:29 +0300
Updated doxy for old Digest Auth API function
This function supports new functionality now (extended notation) and
this functionality is automatically available without rebuilding
application.
Diffstat:
2 files changed, 15 insertions(+), 5 deletions(-)
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h
@@ -96,7 +96,7 @@ extern "C"
* they are parsed as decimal numbers.
* Example: 0x01093001 = 1.9.30-1.
*/
-#define MHD_VERSION 0x00097521
+#define MHD_VERSION 0x00097522
/* If generic headers don't work on your platform, include headers
which define 'va_list', 'size_t', 'ssize_t', 'intptr_t', 'off_t',
@@ -4701,9 +4701,14 @@ MHD_digest_auth_get_username3 (struct MHD_Connection *connection);
/**
* Get the username from the authorization header sent by the client
*
+ * This function supports username in standard and extended notations.
+ * "userhash" is not supported by this function.
+ *
* @param connection The MHD connection structure
- * @return NULL if no username could be found, a pointer
- * to the username if found, free using #MHD_free().
+ * @return NULL if no username could be found, username provided as
+ * "userhash" or memory allocation error occurred;
+ * a pointer to the username if found, free using #MHD_free().
+ * @warning Returned value must be freed by #MHD_free().
* @deprecated use MHD_digest_auth_get_username3()
* @ingroup authentication
*/
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c
@@ -1189,10 +1189,15 @@ MHD_digest_auth_get_username3 (struct MHD_Connection *connection)
/**
* Get the username from the authorization header sent by the client
*
+ * This function support username in standard and extended notations.
+ * "userhash" is not supported by this function.
+ *
* @param connection The MHD connection structure
- * @return NULL if no username could be found, a pointer
- * to the username if found
+ * @return NULL if no username could be found, username provided as
+ * "userhash" or memory allocation error occurs;
+ * a pointer to the username if found, free using #MHD_free().
* @warning Returned value must be freed by #MHD_free().
+ * @deprecated use MHD_digest_auth_get_username3()
* @ingroup authentication
*/
_MHD_EXTERN char *