diff options
author | Steve Holme <steve_holme@hotmail.com> | 2014-11-23 16:31:39 +0000 |
---|---|---|
committer | Steve Holme <steve_holme@hotmail.com> | 2014-11-23 16:50:15 +0000 |
commit | 1450712e76bf69286b151f7012fb40f3d67f504b (patch) | |
tree | eb69fb8e540815459f316385d6b24019e6308be9 /lib | |
parent | bfdef6301c55abe41a8fb8407e024101d7d4dd1d (diff) |
sasl: Tidied up some parameter comments
Diffstat (limited to 'lib')
-rw-r--r-- | lib/curl_sasl.c | 10 | ||||
-rw-r--r-- | lib/curl_sasl_sspi.c | 21 |
2 files changed, 15 insertions, 16 deletions
diff --git a/lib/curl_sasl.c b/lib/curl_sasl.c index 7404bd3f0..b944aa2df 100644 --- a/lib/curl_sasl.c +++ b/lib/curl_sasl.c @@ -357,7 +357,7 @@ CURLcode Curl_sasl_create_login_message(struct SessionHandle *data, * * Parameters: * - * chlg64 [in] - Pointer to the base64 encoded challenge message. + * chlg64 [in] - The base64 encoded challenge message. * outptr [in/out] - The address where a pointer to newly allocated memory * holding the result will be stored upon completion. * outlen [out] - The length of the output message. @@ -454,7 +454,7 @@ CURLcode Curl_sasl_create_cram_md5_message(struct SessionHandle *data, * * Parameters: * - * chlg64 [in] - Pointer to the base64 encoded challenge message. + * chlg64 [in] - The base64 encoded challenge message. * nonce [in/out] - The buffer where the nonce will be stored. * nlen [in] - The length of the nonce buffer. * realm [in/out] - The buffer where the realm will be stored. @@ -526,7 +526,7 @@ static CURLcode sasl_decode_digest_md5_message(const char *chlg64, * Parameters: * * data [in] - The session handle. - * chlg64 [in] - Pointer to the base64 encoded challenge message. + * chlg64 [in] - The base64 encoded challenge message. * userp [in] - The user name. * passdwp [in] - The user's password. * service [in] - The service type such as www, smtp, pop or imap. @@ -705,7 +705,7 @@ CURLcode Curl_sasl_create_digest_md5_message(struct SessionHandle *data, * * Parameters: * - * chlg [in] - Pointer to the challenge message. + * chlg [in] - The challenge message. * digest [in/out] - The digest data struct being used and modified. * * Returns CURLE_OK on success. @@ -1155,7 +1155,7 @@ CURLcode Curl_sasl_create_xoauth2_message(struct SessionHandle *data, * * Parameters: * - * conn [in] - Pointer to the connection data. + * conn [in] - The connection data. * authused [in] - The authentication mechanism used. */ void Curl_sasl_cleanup(struct connectdata *conn, unsigned int authused) diff --git a/lib/curl_sasl_sspi.c b/lib/curl_sasl_sspi.c index 88592cdfa..aa992ce5e 100644 --- a/lib/curl_sasl_sspi.c +++ b/lib/curl_sasl_sspi.c @@ -102,8 +102,8 @@ TCHAR *Curl_sasl_build_spn(const char *service, const char *host) * Parameters: * * data [in] - The session handle. - * chlg64 [in] - Pointer to the base64 encoded challenge message. - * userp [in] - The user name. + * chlg64 [in] - The base64 encoded challenge message. + * userp [in] - The user name in the format User or Domain\User. * passdwp [in] - The user's password. * service [in] - The service type such as www, smtp, pop or imap. * outptr [in/out] - The address where a pointer to newly allocated memory @@ -283,7 +283,7 @@ CURLcode Curl_sasl_create_digest_md5_message(struct SessionHandle *data, * * Parameters: * - * chlg [in] - Pointer to the challenge message. + * chlg [in] - The challenge message. * digest [in/out] - The digest data struct being used and modified. * * Returns CURLE_OK on success. @@ -317,7 +317,7 @@ CURLcode Curl_sasl_decode_digest_http_message(const char *chlg, * Parameters: * * data [in] - The session handle. - * userp [in] - The user name. + * userp [in] - The user name in the format User or Domain\User. * passdwp [in] - The user's password. * request [in] - The HTTP request. * uripath [in] - The path of the HTTP uri. @@ -606,8 +606,8 @@ CURLcode Curl_sasl_create_ntlm_type1_message(const char *userp, * * Parameters: * -* data [in] - Pointer to session handle. -* type2msg [in] - Pointer to the base64 encoded type-2 message. +* data [in] - The session handle. +* type2msg [in] - The base64 encoded type-2 message. * ntlm [in/out] - The ntlm data struct being used and modified. * * Returns CURLE_OK on success. @@ -653,7 +653,7 @@ CURLcode Curl_sasl_decode_ntlm_type2_message(struct SessionHandle *data, * * Parameters: * -* data [in] - Pointer to session handle. +* data [in] - The session handle. * userp [in] - The user name in the format User or Domain\User. * passdwp [in] - The user's password. * ntlm [in/out] - The ntlm data struct being used and modified. @@ -771,13 +771,12 @@ void Curl_sasl_ntlm_cleanup(struct ntlmdata *ntlm) * Parameters: * * data [in] - The session handle. - * userp [in] - The user name. + * userp [in] - The user name in the format User or Domain\User. * passdwp [in] - The user's password. * service [in] - The service type such as www, smtp, pop or imap. * mutual_auth [in] - Flag specifing whether or not mutual authentication * is enabled. - * chlg64 [in] - Pointer to the optional base64 encoded challenge - * message. + * chlg64 [in] - The optional base64 encoded challenge message. * krb5 [in/out] - The gssapi data struct being used and modified. * outptr [in/out] - The address where a pointer to newly allocated memory * holding the result will be stored upon completion. @@ -945,7 +944,7 @@ CURLcode Curl_sasl_create_gssapi_user_message(struct SessionHandle *data, * Parameters: * * data [in] - The session handle. - * chlg64 [in] - Pointer to the optional base64 encoded challenge message. + * chlg64 [in] - The optional base64 encoded challenge message. * krb5 [in/out] - The gssapi data struct being used and modified. * outptr [in/out] - The address where a pointer to newly allocated memory * holding the result will be stored upon completion. |