diff options
author | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-08-16 10:20:11 +0300 |
---|---|---|
committer | Evgeny Grin (Karlson2k) <k2k@narod.ru> | 2022-08-16 10:20:11 +0300 |
commit | 83f50ffcea81a01ee4b06391a884df277d31c76d (patch) | |
tree | bff5c0de1a02e5882749c946f10e0e4b2a3947a3 | |
parent | b7e0c47e2390d4aacce85b95655f9ccf313dfdf8 (diff) | |
download | libmicrohttpd-83f50ffcea81a01ee4b06391a884df277d31c76d.tar.gz libmicrohttpd-83f50ffcea81a01ee4b06391a884df277d31c76d.zip |
digestauth: minor doxy correction for public API
-rw-r--r-- | src/include/microhttpd.h | 9 | ||||
-rw-r--r-- | src/microhttpd/digestauth.c | 13 |
2 files changed, 12 insertions, 10 deletions
diff --git a/src/include/microhttpd.h b/src/include/microhttpd.h index d3765b6c..b2356e5a 100644 --- a/src/include/microhttpd.h +++ b/src/include/microhttpd.h | |||
@@ -5088,7 +5088,7 @@ enum MHD_DigestAuthResult | |||
5088 | * returned; | 5088 | * returned; |
5089 | * zero for no limit | 5089 | * zero for no limit |
5090 | * @param mqop the QOP to use | 5090 | * @param mqop the QOP to use |
5091 | * @param malgo3 digest algorithms allowed to use, fail if algorithm specified | 5091 | * @param malgo3 digest algorithms allowed to use, fail if algorithm used |
5092 | * by the client is not allowed by this parameter | 5092 | * by the client is not allowed by this parameter |
5093 | * @return #MHD_DAUTH_OK if authenticated, | 5093 | * @return #MHD_DAUTH_OK if authenticated, |
5094 | * the error code otherwise | 5094 | * the error code otherwise |
@@ -5133,7 +5133,7 @@ MHD_digest_auth_check3 (struct MHD_Connection *connection, | |||
5133 | * returned; | 5133 | * returned; |
5134 | * zero for no limit | 5134 | * zero for no limit |
5135 | * @param mqop the QOP to use | 5135 | * @param mqop the QOP to use |
5136 | * @param malgo3 digest algorithms allowed to use, fail if algorithm specified | 5136 | * @param malgo3 digest algorithms allowed to use, fail if algorithm used |
5137 | * by the client is not allowed by this parameter; | 5137 | * by the client is not allowed by this parameter; |
5138 | * both MD5-based and SHA-256-based algorithms cannot be used at | 5138 | * both MD5-based and SHA-256-based algorithms cannot be used at |
5139 | * the same time for this function as @a userdigest_size must | 5139 | * the same time for this function as @a userdigest_size must |
@@ -5193,8 +5193,9 @@ MHD_digest_auth_check_digest3 (struct MHD_Connection *connection, | |||
5193 | * to retry immediately with the new nonce and the same | 5193 | * to retry immediately with the new nonce and the same |
5194 | * credentials, without asking user for the new password | 5194 | * credentials, without asking user for the new password |
5195 | * @param mqop the QOP to use | 5195 | * @param mqop the QOP to use |
5196 | * @param malgo3 digest algorithm to use, if several algorithms are specified | 5196 | * @param malgo3 digest algorithm to use, MHD selects; if several algorithms |
5197 | * then MD5 is used (if allowed) | 5197 | * are allowed then MD5 is preferred (currently, may be changed |
5198 | * in next versions) | ||
5198 | * @param userhash_support if set to non-zero value (#MHD_YES) then support of | 5199 | * @param userhash_support if set to non-zero value (#MHD_YES) then support of |
5199 | * userhash is indicated, the client may provide | 5200 | * userhash is indicated, the client may provide |
5200 | * hash("username:realm") instead of username in | 5201 | * hash("username:realm") instead of username in |
diff --git a/src/microhttpd/digestauth.c b/src/microhttpd/digestauth.c index 1061512d..0f428d86 100644 --- a/src/microhttpd/digestauth.c +++ b/src/microhttpd/digestauth.c | |||
@@ -2660,7 +2660,7 @@ MHD_digest_auth_check (struct MHD_Connection *connection, | |||
2660 | * returned; | 2660 | * returned; |
2661 | * zero for no limit | 2661 | * zero for no limit |
2662 | * @param mqop the QOP to use | 2662 | * @param mqop the QOP to use |
2663 | * @param malgo3 digest algorithms allowed to use, fail if algorithm specified | 2663 | * @param malgo3 digest algorithms allowed to use, fail if algorithm used |
2664 | * by the client is not allowed by this parameter | 2664 | * by the client is not allowed by this parameter |
2665 | * @return #MHD_DAUTH_OK if authenticated, | 2665 | * @return #MHD_DAUTH_OK if authenticated, |
2666 | * the error code otherwise | 2666 | * the error code otherwise |
@@ -2718,7 +2718,7 @@ MHD_digest_auth_check3 (struct MHD_Connection *connection, | |||
2718 | * returned; | 2718 | * returned; |
2719 | * zero for no limit | 2719 | * zero for no limit |
2720 | * @param mqop the QOP to use | 2720 | * @param mqop the QOP to use |
2721 | * @param malgo3 digest algorithms allowed to use, fail if algorithm specified | 2721 | * @param malgo3 digest algorithms allowed to use, fail if algorithm used |
2722 | * by the client is not allowed by this parameter; | 2722 | * by the client is not allowed by this parameter; |
2723 | * both MD5-based and SHA-256-based algorithms cannot be used at | 2723 | * both MD5-based and SHA-256-based algorithms cannot be used at |
2724 | * the same time for this function as @a userdigest_size must | 2724 | * the same time for this function as @a userdigest_size must |
@@ -2934,8 +2934,8 @@ MHD_digest_auth_check_digest (struct MHD_Connection *connection, | |||
2934 | * same authorisation could be used, URIs can be in form | 2934 | * same authorisation could be used, URIs can be in form |
2935 | * "path-absolute" (the path for the same host with initial slash) | 2935 | * "path-absolute" (the path for the same host with initial slash) |
2936 | * or in form "absolute-URI" (the full path with protocol), in | 2936 | * or in form "absolute-URI" (the full path with protocol), in |
2937 | * any case client may assume that any URI which starts with | 2937 | * any case client may assume that URI is in the same "protection |
2938 | * any of specified URI is in the same "protection space"; | 2938 | * space" if it starts with any of values specified here; |
2939 | * could be NULL (clients typically assume that the same | 2939 | * could be NULL (clients typically assume that the same |
2940 | * credentials could be used for any URI on the same host) | 2940 | * credentials could be used for any URI on the same host) |
2941 | * @param response the reply to send; should contain the "access denied" | 2941 | * @param response the reply to send; should contain the "access denied" |
@@ -2947,8 +2947,9 @@ MHD_digest_auth_check_digest (struct MHD_Connection *connection, | |||
2947 | * to retry immediately with the new nonce and the same | 2947 | * to retry immediately with the new nonce and the same |
2948 | * credentials, without asking user for the new password | 2948 | * credentials, without asking user for the new password |
2949 | * @param mqop the QOP to use | 2949 | * @param mqop the QOP to use |
2950 | * @param malgo3 digest algorithm to use, if several algorithms are specified | 2950 | * @param malgo3 digest algorithm to use, MHD selects; if several algorithms |
2951 | * then MD5 is used (if allowed) | 2951 | * are allowed then MD5 is preferred (currently, may be changed |
2952 | * in next versions) | ||
2952 | * @param userhash_support if set to non-zero value (#MHD_YES) then support of | 2953 | * @param userhash_support if set to non-zero value (#MHD_YES) then support of |
2953 | * userhash is indicated, the client may provide | 2954 | * userhash is indicated, the client may provide |
2954 | * hash("username:realm") instead of username in | 2955 | * hash("username:realm") instead of username in |