Author: kaushalye
Date: Sun Nov 25 21:45:36 2007
New Revision: 598141
URL: http://svn.apache.org/viewvc?rev=598141&view=rev
Log:
Header comments and code cleaning
Modified:
webservices/rampart/trunk/c/include/openssl_cipher_ctx.h
webservices/rampart/trunk/c/include/openssl_cipher_property.h
webservices/rampart/trunk/c/samples/secpolicy/scenario2/services.xml
Modified: webservices/rampart/trunk/c/include/openssl_cipher_ctx.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/openssl_cipher_ctx.h?rev=598141&r1=598140&r2=598141&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/openssl_cipher_ctx.h (original)
+++ webservices/rampart/trunk/c/include/openssl_cipher_ctx.h Sun Nov 25
21:45:36 2007
@@ -90,24 +90,52 @@
openssl_cipher_ctx_t *ctx,
const axutil_env_t *env);
+ /**
+ * Set the Cipher for the cipher context.
+ * @param ctx to the openssl cipher ctx struct
+ * @param env pointer to environment struct
+ * @param EVP_CIPHER The pointer for the Cipher to be set in the cipher
context
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_ctx_set_cipher(
openssl_cipher_ctx_t *ctx,
const axutil_env_t *env,
const EVP_CIPHER*);
+ /**
+ * Set the Key for the cipher context.
+ * @param ctx to the openssl cipher ctx struct
+ * @param env pointer to environment struct
+ * @param key The key to be set in the cipher context
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_ctx_set_key(
openssl_cipher_ctx_t *ctx,
const axutil_env_t *env,
oxs_key_t *key);
+ /**
+ * Set the Initial Value for the cipher context.
+ * @param ctx to the openssl cipher ctx struct
+ * @param env pointer to environment struct
+ * @param iv The Initial Value to be set in the cipher context
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_ctx_set_iv(
openssl_cipher_ctx_t *ctx,
const axutil_env_t *env,
axis2_char_t *iv);
+ /**
+ * Set the pad for the cipher context.
+ * @param ctx to the openssl cipher ctx struct
+ * @param env pointer to environment struct
+ * @param pad the pad to be set in the cipher context
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_ctx_set_pad(
openssl_cipher_ctx_t *ctx,
@@ -115,7 +143,11 @@
axis2_char_t *pad);
- /*Create function*/
+ /**
+ * Create a new cipher context. All the fields carry NULL values at the
begining.
+ * @param env pointer to environment struct
+ * @return Fresh Cipher Context
+ */
AXIS2_EXTERN openssl_cipher_ctx_t *AXIS2_CALL
openssl_cipher_ctx_create(const axutil_env_t *env);
Modified: webservices/rampart/trunk/c/include/openssl_cipher_property.h
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/include/openssl_cipher_property.h?rev=598141&r1=598140&r2=598141&view=diff
==============================================================================
--- webservices/rampart/trunk/c/include/openssl_cipher_property.h (original)
+++ webservices/rampart/trunk/c/include/openssl_cipher_property.h Sun Nov 25
21:45:36 2007
@@ -39,54 +39,119 @@
typedef struct openssl_cipher_property_t openssl_cipher_property_t;
+ /**
+ * Given the OpenSSL cipher property returns the cipher
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return the cipher
+ */
EVP_CIPHER * AXIS2_CALL
openssl_cipher_property_get_cipher(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Given the OpenSSL cipher property returns the name of the property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return the name of the cipher property
+ */
axis2_char_t * AXIS2_CALL
openssl_cipher_property_get_name(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Given the OpenSSL cipher property returns the URL
+ * Which usually is an algorithm URL
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return the URL
+ */
axis2_char_t * AXIS2_CALL
openssl_cipher_property_get_url(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Given the OpenSSL cipher property returns the size of the key
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return size of the key
+ */
int AXIS2_CALL
openssl_cipher_property_get_key_size(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Given the OpenSSL cipher property returns the cipher block size
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return the block size of the cipher
+ */
int AXIS2_CALL
openssl_cipher_property_get_block_size(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Given the OpenSSL cipher property returns the size of the initial vector
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return the size of the initial vector
+ */
int AXIS2_CALL
openssl_cipher_property_get_iv_size(
const openssl_cipher_property_t *cprop,
const axutil_env_t *env);
+ /**
+ * Set the Cipher for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param cipher The cipher to be set in the property
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_cipher(
openssl_cipher_property_t *cprop,
const axutil_env_t *env,
EVP_CIPHER *cipher);
+ /**
+ * Set the name for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param name of the OpenSSL cipher property
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_name(
openssl_cipher_property_t *cprop,
const axutil_env_t *env,
axis2_char_t *name);
+ /**
+ * Set the url for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param url The URL of the OpenSSL cipher property
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_url(
openssl_cipher_property_t *cprop,
const axutil_env_t *env,
- axis2_char_t *name);
+ axis2_char_t *url);
+ /**
+ * Set the the size of the key for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param key_size the size of the key
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_key_size(
openssl_cipher_property_t *cprop,
@@ -94,25 +159,47 @@
int key_size);
+ /**
+ * Set the size of the cipher block for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param block_size the size of the cipher block
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_block_size(
openssl_cipher_property_t *cprop,
const axutil_env_t *env,
int block_size);
+ /**
+ * Set the size of the initial vector for the OpenSSL cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @param iv_size the size of the initial vector
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
openssl_cipher_property_set_iv_size(
openssl_cipher_property_t *cprop,
const axutil_env_t *env,
int iv_size);
+ /**
+ * Free the cipher property
+ * @param cprop The OpenSSL cipher property
+ * @param env pointer to environment struct
+ * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
+ */
axis2_status_t AXIS2_CALL
- openssl_cipher_property_free(openssl_cipher_property_t * cprop, const
axutil_env_t *env);
+ openssl_cipher_property_free(openssl_cipher_property_t * cprop,
+ const axutil_env_t *env);
/**
* Create a fresh block cipher property
- [EMAIL PROTECTED] cipher_prop_ptr
+ * @param env pointer to environment struct
+ * @return cipher_prop_ptr
*/
AXIS2_EXTERN openssl_cipher_property_t *AXIS2_CALL
openssl_cipher_property_create(const axutil_env_t *env);
Modified: webservices/rampart/trunk/c/samples/secpolicy/scenario2/services.xml
URL:
http://svn.apache.org/viewvc/webservices/rampart/trunk/c/samples/secpolicy/scenario2/services.xml?rev=598141&r1=598140&r2=598141&view=diff
==============================================================================
--- webservices/rampart/trunk/c/samples/secpolicy/scenario2/services.xml
(original)
+++ webservices/rampart/trunk/c/samples/secpolicy/scenario2/services.xml Sun
Nov 25 21:45:36 2007
@@ -46,7 +46,6 @@
</wsp:Policy>
</sp:SignedSupportingTokens>
<rampc:RampartConfig
xmlns:rampc="http://ws.apache.org/rampart/c/policy">
- <rampc:User>Bob</rampc:User>
<rampc:PasswordType>Digest</rampc:PasswordType>
<!--rampc:AuthnModuleName>AXIS2C_HOME/bin/samples/rampart/authn_provider/libauthn.so</rampc:AuthnModuleName-->
<rampc:PasswordCallbackClass>AXIS2C_HOME/bin/samples/rampart/callback/libpwcb.so</rampc:PasswordCallbackClass>