Key
[OMXMLSecurity]

Defines
#define	OXS_KEY_USAGE_SIGN   0
#define	OXS_KEY_USAGE_VERIFY   1
#define	OXS_KEY_USAGE_ENCRYPT   2
#define	OXS_KEY_USAGE_DECRYPT   3
#define	OXS_KEY_USAGE_NONE   4
#define	OXS_KEY_DEFAULT_SIZE   64
Typedefs
typedef oxs_key_t	oxs_key_t
Functions
unsigned char *	oxs_key_get_data (const oxs_key_t *key, const axutil_env_t *env)
axis2_char_t *	oxs_key_get_name (const oxs_key_t *key, const axutil_env_t *env)
int	oxs_key_get_size (const oxs_key_t *key, const axutil_env_t *env)
int	oxs_key_get_usage (const oxs_key_t *key, const axutil_env_t *env)
axis2_status_t	oxs_key_set_name (oxs_key_t *key, const axutil_env_t *env, axis2_char_t *name)
axis2_status_t	oxs_key_set_usage (oxs_key_t *key, const axutil_env_t *env, int usage)
axis2_status_t	oxs_key_free (oxs_key_t *key, const axutil_env_t *env)
axis2_status_t	oxs_key_populate_with_buf (oxs_key_t *key, const axutil_env_t *env, oxs_buffer_t *buffer, axis2_char_t *name, int usage)
axis2_status_t	oxs_key_populate (oxs_key_t *key, const axutil_env_t *env, unsigned char *data, axis2_char_t *name, int size, int usage)
axis2_status_t	oxs_key_read_from_file (oxs_key_t *key, const axutil_env_t *env, axis2_char_t *file_name)
axis2_status_t	oxs_key_for_algo (oxs_key_t *key, const axutil_env_t *env, axis2_char_t *key_algo)
oxs_buffer_t *	oxs_key_get_buffer (const oxs_key_t *key, const axutil_env_t *env)
oxs_key_t *	oxs_key_dup (oxs_key_t *key, const axutil_env_t *env)
AXIS2_EXTERN oxs_key_t *	oxs_key_create (const axutil_env_t *env)

---

Typedef Documentation

typedef struct oxs_key_t oxs_key_t

Type name for struct oxs_key

---

Function Documentation

axis2_status_t oxs_key_for_algo	(	oxs_key_t *	key,
		const axutil_env_t *	env,
		axis2_char_t *	key_algo
	)

Fill the key for the given algo.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t oxs_key_free	(	oxs_key_t *	key,
		const axutil_env_t *	env
	)

Free function for key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

unsigned char* oxs_key_get_data	(	const oxs_key_t *	key,
		const axutil_env_t *	env
	)

Gets data of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

data

axis2_char_t* oxs_key_get_name	(	const oxs_key_t *	key,
		const axutil_env_t *	env
	)

Gets the name of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

name of the key

int oxs_key_get_size	(	const oxs_key_t *	key,
		const axutil_env_t *	env
	)

Gets the size of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

size of the key

int oxs_key_get_usage	(	const oxs_key_t *	key,
		const axutil_env_t *	env
	)

Gets the usage of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

usage of the key

axis2_status_t oxs_key_populate	(	oxs_key_t *	key,
		const axutil_env_t *	env,
		unsigned char *	data,
		axis2_char_t *	name,
		int	size,
		int	usage
	)

Populate a key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct
	data	data of the key
	name	name of the key
	size	size of the key
	usage	usage of the key

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t oxs_key_read_from_file	(	oxs_key_t *	key,
		const axutil_env_t *	env,
		axis2_char_t *	file_name
	)

Read a key from a file.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t oxs_key_set_name	(	oxs_key_t *	key,
		const axutil_env_t *	env,
		axis2_char_t *	name
	)

Sets the name of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct
	name	name of the key

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

axis2_status_t oxs_key_set_usage	(	oxs_key_t *	key,
		const axutil_env_t *	env,
		int	usage
	)

Set the usage of the key.

Parameters:

	key	oxs_key ptr to key
	env	pointer to environment struct
	usage	usage of the key

Returns:

AXIS2_SUCCESS on success, else AXIS2_FAILURE

---