Commit e240da39 authored by Pekka Pessi's avatar Pekka Pessi

auth_client.c: updated documentation.

darcs-hash:20061213001412-65a35-266bef139d05e0a6e99ffa4b69e7ff39c5f75804.gz
parent 14239ce7
......@@ -87,10 +87,10 @@ static int ca_clear_credentials(auth_client_t *ca,
* The function auc_challenge() merges the challenge @a ch to the list of
* authenticators @a auc_list.
*
* @param auc_list [in/out] list of authenticators to be updated
* @param home [in/out] memory home used for allocating authenticators
* @param ch [in] challenge to be processed
* @param crcl [in] credential class
* @param[in,out] auc_list list of authenticators to be updated
* @param[in,out] home memory home used for allocating authenticators
* @param[in] ch challenge to be processed
* @param[in] crcl credential class
*
* @retval 1 when challenge was updated
* @retval 0 when there was no new challenges
......@@ -188,9 +188,9 @@ int ca_challenge(auth_client_t *ca,
* The function auc_info() feeds the authentication data from the
* authentication info @a info to the list of authenticators @a auc_list.
*
* @param auc_list [in/out] list of authenticators to be updated
* @param info [in] info to be processed
* @param crcl [in] corresponding credential class
* @param[in,out] auc_list list of authenticators to be updated
* @param[in] info info to be processed
* @param[in] crcl corresponding credential class
*
* The authentication info can be in either Authentication-Info or in
* Proxy-Authentication-Info headers.
......@@ -277,9 +277,9 @@ int ca_info(auth_client_t *ca,
*
* @todo The authentication data format sucks.
*
* @param auc_list [in/out] list of authenticators
* @param home [in/out] memory home used for allocations
* @param data [in] colon-separated authentication data
* @param[in,out] auc_list list of authenticators
* @param[in,out] home memory home used for allocations
* @param[in] data colon-separated authentication data
*
* @retval 0 when successful
* @retval -1 upon an error
......@@ -330,11 +330,11 @@ int auc_credentials(auth_client_t **auc_list, su_home_t *home,
*
* @todo The authentication data format sucks.
*
* @param auc_list [in/out] list of authenticators
* @param scheme [in] scheme to use (NULL, if any)
* @param realm [in] realm to use (NULL, if any)
* @param user [in] username
* @param pass [in] password
* @param[in,out] auc_list list of authenticators
* @param[in] scheme scheme to use (NULL, if any)
* @param[in] realm realm to use (NULL, if any)
* @param[in] user username
* @param[in] pass password
*
* @retval number of matching clients
* @retval 0 when no matching client was found
......@@ -445,9 +445,9 @@ int auc_copy_credentials(auth_client_t **dst,
* The function auc_clear_credentials() is used to remove the credentials
* from the authenticators.
*
* @param auc_list [in/out] list of authenticators
* @param scheme [in] scheme (if non-null, remove only matching credentials)
* @param realm [in] realm (if non-null, remove only matching credentials)
* @param[in,out] auc_list list of authenticators
* @param[in] scheme scheme (if non-null, remove only matching credentials)
* @param[in] realm realm (if non-null, remove only matching credentials)
*
* @retval 0 when successful
* @retval -1 upon an error
......@@ -518,12 +518,12 @@ int auc_has_authorization(auth_client_t **auc_list)
* headers to a request. The authentication headers will contain the
* credentials generated by the list of authenticators.
*
* @param auc_list [in/out] list of authenticators
* @param msg [out] message to be authenticated
* @param pub [out] headers of the message
* @param method [in] request method
* @param url [in] request URI
* @param body [in] message body (NULL if empty)
* @param[in,out] auc_list list of authenticators
* @param[out] msg message to be authenticated
* @param[out] pub headers of the message
* @param[in] method request method
* @param[in] url request URI
* @param[in] body message body (NULL if empty)
*
* @retval 1 when successful
* @retval 0 when there is not enough credentials
......@@ -578,12 +578,12 @@ int auc_authorization(auth_client_t **auc_list, msg_t *msg, msg_pub_t *pub,
* authentication headers for a request. The list of authentication headers
* will contain the credentials generated by the list of authenticators.
*
* @param auc_list [in/out] list of authenticators
* @param home [in] memory home used to allocate headers
* @param method [in] request method
* @param url [in] request URI
* @param body [in] message body (NULL if empty)
* @param return_headers [out] authorization headers
* @param[in] auc_list list of authenticators
* @param[in] home memory home used to allocate headers
* @param[in] method request method
* @param[in] url request URI
* @param[in] body message body (NULL if empty)
* @param[out] return_headers authorization headers return value
*
* @retval 1 when successful
* @retval 0 when there is not enough credentials
......@@ -602,7 +602,7 @@ int auc_authorization_headers(auth_client_t **auc_list,
if (!auc_has_authorization(auc_list))
return 0;
/* Insert new credentials */
/* Create new credential headers */
for (; *auc_list; auc_list = &(*auc_list)->ca_next) {
msg_header_t *h = NULL;
......@@ -815,22 +815,11 @@ static int auc_digest_info(auth_client_t *ca,
* sip_authorization_class or sip_proxy_authorization_class, as well as
* http_authorization_class or http_proxy_authorization_class.
*
* @param home memory home used to allocate memory for the new header
* @param hc header class for the header to be created
* @param user user name
* @param pass password
* @param ac challenge structure
* @param cnonce client nonce
* @param nc client nonce count
* @param method request method
* @param uri request uri
* @param data message body
* @param dlen length of message body
*
* @return
* Returns a pointer to newly created authorization header, or NULL upon an
* error.
*/
static
int auc_digest_authorization(auth_client_t *ca,
su_home_t *home,
char const *method,
......@@ -1006,9 +995,9 @@ void ca_destroy(su_home_t *home, auth_client_t *ca)
* headers to a SIP request. The authentication headers will contain the
* credentials generated by the list of authenticators.
*
* @param auc_list [in/out] list of authenticators
* @param msg [in/out] message to be authenticated
* @param sip [in/out] sip headers of the message
* @param[in,out] auc_list list of authenticators
* @param[in,out] msg message to be authenticated
* @param[in,out] sip sip headers of the message
*
* @retval 1 when successful
* @retval 0 when there is not enough credentials
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment