You are viewing a plain text version of this content. The canonical link for it is here.
Posted to rampart-dev@ws.apache.org by ka...@apache.org on 2007/09/21 17:45:53 UTC
svn commit: r578180 - in /webservices/rampart/trunk/c/include: oxs_buffer.h
oxs_cipher.h rampart_authn_provider.h rampart_credentials.h
Author: kaushalye
Date: Fri Sep 21 08:45:52 2007
New Revision: 578180
URL: http://svn.apache.org/viewvc?rev=578180&view=rev
Log:
Documentation.
Modified:
webservices/rampart/trunk/c/include/oxs_buffer.h
webservices/rampart/trunk/c/include/oxs_cipher.h
webservices/rampart/trunk/c/include/rampart_authn_provider.h
webservices/rampart/trunk/c/include/rampart_credentials.h
Modified: webservices/rampart/trunk/c/include/oxs_buffer.h
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/oxs_buffer.h?rev=578180&r1=578179&r2=578180&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/oxs_buffer.h (original)
+++ webservices/rampart/trunk/c/include/oxs_buffer.h Fri Sep 21 08:45:52 2007
@@ -60,8 +60,8 @@
/**
*Free function of the buffer
- *@buffer pointer to the OMXMLSec buffer struct
- *@env pointer to environment struct
+ *@param buffer pointer to the OMXMLSec buffer struct
+ *@param env pointer to environment struct
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t AXIS2_CALL
@@ -71,9 +71,9 @@
);
/**
*Removes the first (size) charcters from the buffer
- *@buffer pointer to the OMXMLSec buffer struct
- *@env pointer to environment struct
- *@size number of characters to be removed
+ *@param buffer pointer to the OMXMLSec buffer struct
+ *@param env pointer to environment struct
+ *@param size number of characters to be removed
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t AXIS2_CALL
@@ -84,9 +84,9 @@
);
/**
*Removes the last (size) charcters from the buffer
- *@buffer pointer to the OMXMLSec buffer struct
- *@env pointer to environment struct
- *@size number of characters to be removed
+ *@param buffer pointer to the OMXMLSec buffer struct
+ *@param env pointer to environment struct
+ *@param size number of characters to be removed
*@return AXIS2_SUCCESS on success, else AXIS2_FAILURE
*/
axis2_status_t AXIS2_CALL
Modified: webservices/rampart/trunk/c/include/oxs_cipher.h
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/oxs_cipher.h?rev=578180&r1=578179&r2=578180&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/oxs_cipher.h (original)
+++ webservices/rampart/trunk/c/include/oxs_cipher.h Fri Sep 21 08:45:52 2007
@@ -42,9 +42,9 @@
/**
* Get the cipher property for the given url
- * @env pointer to environment struct
- * @url the url as a string
- * @return the property
+ * @param env pointer to environment struct
+ * @param url the url as a string
+ * @param return the property
*/
AXIS2_EXTERN openssl_cipher_property_t *AXIS2_CALL
oxs_get_cipher_property_for_url(const axutil_env_t *env,
@@ -52,9 +52,9 @@
/**
* Get the cipher name for the given url
- * @env pointer to environment struct
- * @url the url as a string
- * @return the name as a string
+ * @param env pointer to environment struct
+ * @param url the url as a string
+ * @param return the name as a string
*/
AXIS2_EXTERN axis2_char_t* AXIS2_CALL
oxs_get_cipher_name_for_url(const axutil_env_t *env,
@@ -62,9 +62,9 @@
/**
* Get the cipher url for the given name
- *@env pointer to environment struct
- *@name the name as a string
- *@return the url as a string
+ *@param env pointer to environment struct
+ *@param name the name as a string
+ *@param return the url as a string
*/
AXIS2_EXTERN axis2_char_t* AXIS2_CALL
oxs_get_cipher_url_for_name(const axutil_env_t *env,
Modified: webservices/rampart/trunk/c/include/rampart_authn_provider.h
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_authn_provider.h?rev=578180&r1=578179&r2=578180&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_authn_provider.h (original)
+++ webservices/rampart/trunk/c/include/rampart_authn_provider.h Fri Sep 21 08:45:52 2007
@@ -77,8 +77,8 @@
* @param authn_provider the authentication provider struct
* @param env pointer to environment struct
* @param msg_ctx message context
- * @username the username
- * @password the password in plain text
+ * @param username the username
+ * @param password the password in plain text
* @return the status of the check
*/
rampart_authn_provider_status_t (AXIS2_CALL*
@@ -95,10 +95,10 @@
* @param authn_provider the authentication provider struct
* @param env pointer to environment struct
* @param msg_ctx message context
- * @username the username
- * @nonce the noce or the random value of the username token
- * @created the created value of the username token
- * @digest the digest value of the SHA-1(password+created+nonce)
+ * @param username the username
+ * @param nonce the noce or the random value of the username token
+ * @param created the created value of the username token
+ * @param digest the digest value of the SHA-1(password+created+nonce)
* @return the status of the check
*/
rampart_authn_provider_status_t (AXIS2_CALL*
Modified: webservices/rampart/trunk/c/include/rampart_credentials.h
URL: http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/rampart_credentials.h?rev=578180&r1=578179&r2=578180&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/rampart_credentials.h (original)
+++ webservices/rampart/trunk/c/include/rampart_credentials.h Fri Sep 21 08:45:52 2007
@@ -69,7 +69,12 @@
/**
* Implementation must provide both username and the password.
- *
+ * @param credentials pointer to the credentials struct
+ * @param env pointer to the environment struct
+ * @param msg_ctx Message context
+ * @param username Reference to the username
+ * @param password Reference to the password
+ * @return The status of extracting credentials
*/
rampart_credentials_status_t (AXIS2_CALL*
rampart_credentials_username_get)(
@@ -79,7 +84,12 @@
axis2_char_t **username,
axis2_char_t **password
);
-
+ /**
+ * The free function for the credentials
+ * @param credentials pointer to the credentials struct
+ * @param env pointer to the environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t (AXIS2_CALL*
free)(rampart_credentials_t *credentials,
const axutil_env_t* env);