stv0g/re
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

httpauth: add doxygen comments + const

Browse source
This commit is contained in:
Richard Aas 2011-12-09 11:45:17 +00:00
parent 3729d9fc6f
commit ab2fd196b5
2 changed files with 29 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
include/re_httpauth.h
View file

@ -5,6 +5,7 @@
*/ */
/** HTTP Digest Challenge */
struct httpauth_digest_chall { struct httpauth_digest_chall {
struct pl realm; struct pl realm;
struct pl nonce; struct pl nonce;
@ -16,6 +17,7 @@ struct httpauth_digest_chall {
struct pl qop; struct pl qop;
}; };
/** HTTP Digest response */
struct httpauth_digest_resp { struct httpauth_digest_resp {
struct pl realm; struct pl realm;
struct pl nonce; struct pl nonce;
@ -34,5 +36,5 @@ int httpauth_digest_challenge_decode(struct httpauth_digest_chall *chall,
const struct pl *hval); const struct pl *hval);
int httpauth_digest_response_decode(struct httpauth_digest_resp *resp, int httpauth_digest_response_decode(struct httpauth_digest_resp *resp,
const struct pl *hval); const struct pl *hval);
int httpauth_digest_response_auth(struct httpauth_digest_resp *resp, int httpauth_digest_response_auth(const struct httpauth_digest_resp *resp,
const struct pl *method, const uint8_t *ha1); const struct pl *method, const uint8_t *ha1);

27
src/httpauth/digest.c
View file

@ -97,6 +97,14 @@ static int digest_decode(const struct pl *hval, digest_decode_h *dech,
} }
/**
* Decode a Digest challenge
*
* @param chall Digest challenge object to decode into
* @param hval Header value to decode from
*
* @return 0 if successfully decoded, otherwise errorcode
*/
int httpauth_digest_challenge_decode(struct httpauth_digest_chall *chall, int httpauth_digest_challenge_decode(struct httpauth_digest_chall *chall,
const struct pl *hval) const struct pl *hval)
{ {
@ -118,6 +126,14 @@ int httpauth_digest_challenge_decode(struct httpauth_digest_chall *chall,
} }
/**
* Decode a Digest response
*
* @param resp Digest response object to decode into
* @param hval Header value to decode from
*
* @return 0 if successfully decoded, otherwise errorcode
*/
int httpauth_digest_response_decode(struct httpauth_digest_resp *resp, int httpauth_digest_response_decode(struct httpauth_digest_resp *resp,
const struct pl *hval) const struct pl *hval)
{ {
@ -143,7 +159,16 @@ int httpauth_digest_response_decode(struct httpauth_digest_resp *resp,
} }
int httpauth_digest_response_auth(struct httpauth_digest_resp *resp, /**
* Authenticate a digest response
*
* @param resp Digest response
* @param method Request method
* @param ha1 HA1 value from MD5(username:realm:password)
*
* @return 0 if successfully authenticated, otherwise errorcode
*/
int httpauth_digest_response_auth(const struct httpauth_digest_resp *resp,
const struct pl *method, const uint8_t *ha1) const struct pl *method, const uint8_t *ha1)
{ {
uint8_t ha2[MD5_SIZE], digest[MD5_SIZE], response[MD5_SIZE]; uint8_t ha2[MD5_SIZE], digest[MD5_SIZE], response[MD5_SIZE];