Classes
class	Component_callbacks

Typedefs
using	config_vector = std::vector< std::pair< std::string, std::string > >

Functions
bool	aes_get_encrypted_size_template (size_t input_length, const char mode, size_t block_size, size_t out_size)
	Retrieve required out buffer length information. More...

template<typename Backend , typename Data_extension = Data>
bool	aes_encrypt_template (const char data_id, const char auth_id, const char mode, size_t block_size, const unsigned char iv, bool padding, const unsigned char data_buffer, size_t data_buffer_length, unsigned char out_buffer, size_t out_buffer_length, size_t *out_length, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Encrypt given piece of plaintext. More...

template<typename Backend , typename Data_extension = Data>
bool	aes_decrypt_template (const char data_id, const char auth_id, const char mode, size_t block_size, const unsigned char iv, bool padding, const unsigned char data_buffer, size_t data_buffer_length, unsigned char out_buffer, size_t out_buffer_length, size_t *out_length, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Decrypt given piece ciphertext. More...

template<typename Backend , typename Data_extension = data::Data>
bool	generate_template (const char data_id, const char auth_id, const char *data_type, size_t data_size, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Generate data and store in keyring. More...

template<typename Backend , typename Data_extension = Data>
bool	init_keys_metadata_iterator_template (std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Forward iterator initialization. More...

template<typename Backend , typename Data_extension = Data>
bool	deinit_keys_metadata_iterator_template (std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Iterator deinitialization. More...

template<typename Backend , typename Data_extension = Data>
bool	keys_metadata_iterator_is_valid (std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Check validity of the iterator. More...

template<typename Backend , typename Data_extension = Data>
bool	keys_metadata_iterator_next (std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Move iterator forward. More...

template<typename Backend , typename Data_extension = Data>
bool	keys_metadata_get_length_template (std::unique_ptr< Iterator< Data_extension > > &it, size_t data_id_length, size_t auth_id_length, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Fetch length of metadata for current key pointed by iterator. More...

template<typename Backend , typename Data_extension = Data>
bool	keys_metadata_get_template (std::unique_ptr< Iterator< Data_extension > > &it, char data_id, size_t data_id_length, char auth_id, size_t auth_id_length, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Fetch metadata for current key pointed by iterator. More...

bool	keyring_metadata_query_keyring_initialized_template (Component_callbacks &callbacks)
	Returns status of the keyring component. More...

bool	keyring_metadata_query_init_template (std::unique_ptr< config_vector > &it, Component_callbacks &callbacks)
	Initialize metadata iterator. More...

bool	keyring_metadata_query_deinit_template (std::unique_ptr< config_vector > &it)
	Deinitialize metadata iterator. More...

bool	keyring_metadata_query_is_valid_template (std::unique_ptr< config_vector > &it)
	Check validity of iterator. More...

bool	keyring_metadata_query_next_template (std::unique_ptr< config_vector > &it)
	Move iterator forward. More...

bool	keyring_metadata_query_get_length_template (std::unique_ptr< config_vector > &it, size_t key_buffer_length, size_t value_buffer_length)
	Get length information about metadata key and value. More...

bool	keyring_metadata_query_get_template (char key_buffer, size_t key_buffer_length, char value_buffer, size_t value_buffer_length, std::unique_ptr< config_vector > &it)
	Get name and value of metadata at current position. More...

template<typename Backend , typename Data_extension = data::Data>
int	init_reader_template (const char data_id, const char auth_id, std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Initialize reader. More...

template<typename Backend , typename Data_extension = data::Data>
bool	deinit_reader_template (std::unique_ptr< Iterator< Data_extension > > &it, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Deinitialize reader. More...

template<typename Backend , typename Data_extension = data::Data>
bool	fetch_length_template (std::unique_ptr< Iterator< Data_extension > > &it, size_t data_size, size_t data_type_size, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Fetch length of the data. More...

template<typename Backend , typename Data_extension = data::Data>
bool	fetch_template (std::unique_ptr< Iterator< Data_extension > > &it, unsigned char data_buffer, size_t data_buffer_length, size_t data_size, char data_type_buffer, size_t data_type_buffer_length, size_t data_type_size, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Fetches data from keyring. More...

template<typename Backend , typename Data_extension = data::Data>
bool	store_template (const char data_id, const char auth_id, const unsigned char data, size_t data_size, const char data_type, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Store data in keyring. More...

template<typename Backend , typename Data_extension = data::Data>
bool	remove_template (const char data_id, const char auth_id, Keyring_operations< Backend, Data_extension > &keyring_operations, Component_callbacks &callbacks)
	Remove data from keyring. More...

Typedef Documentation

◆ config_vector

using keyring_common::service_implementation::config_vector = typedef std::vector<std::pair<std::string, std::string> >

Function Documentation

◆ aes_decrypt_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::aes_decrypt_template	(	const char *	data_id,
		const char *	auth_id,
		const char *	mode,
		size_t	block_size,
		const unsigned char *	iv,
		bool	padding,
		const unsigned char *	data_buffer,
		size_t	data_buffer_length,
		unsigned char *	out_buffer,
		size_t	out_buffer_length,
		size_t *	out_length,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Decrypt given piece ciphertext.

Parameters

[in]	data_id	Name of the key
[in]	auth_id	Owner of the key
[in]	mode	AES mode
[in]	block_size	AES block size information
[in]	iv	Initialization vector
[in]	padding	padding preference
[in]	data_buffer	Input buffer
[in]	data_buffer_length	Input buffer length
[out]	out_buffer	Output buffer
[in]	out_buffer_length	Output buffer length
[out]	out_length	Length of decrypted data
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

◆ aes_encrypt_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::aes_encrypt_template	(	const char *	data_id,
		const char *	auth_id,
		const char *	mode,
		size_t	block_size,
		const unsigned char *	iv,
		bool	padding,
		const unsigned char *	data_buffer,
		size_t	data_buffer_length,
		unsigned char *	out_buffer,
		size_t	out_buffer_length,
		size_t *	out_length,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Encrypt given piece of plaintext.

Parameters

[in]	data_id	Name of the key
[in]	auth_id	Owner of the key
[in]	mode	AES mode
[in]	block_size	AES block size information
[in]	iv	Initialization vector
[in]	padding	padding preference
[in]	data_buffer	Input buffer
[in]	data_buffer_length	Input buffer length
[out]	out_buffer	Output buffer
[in]	out_buffer_length	Output buffer length
[out]	out_length	Length of encrypted data
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

◆ aes_get_encrypted_size_template()

bool keyring_common::service_implementation::aes_get_encrypted_size_template	(	size_t	input_length,
		const char *	mode,
		size_t	block_size,
		size_t *	out_size
	)

Retrieve required out buffer length information.

Parameters

[in]	input_length	Length of input text
[in]	mode	Block encryption mode
[in]	block_size	AES block size
[out]	out_size	Out buffer length

Returns: Output buffer length or error

Return values

false	Success
true	Error processing given mode and/or block size

◆ deinit_keys_metadata_iterator_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::deinit_keys_metadata_iterator_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Iterator deinitialization.

Parameters

[out]	it	metadata iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: Status of the operation

Return values

false	Success
true	Failure

◆ deinit_reader_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::deinit_reader_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Deinitialize reader.

Parameters

[in,out]	it	Iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

◆ fetch_length_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::fetch_length_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		size_t *	data_size,
		size_t *	data_type_size,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Fetch length of the data.

Parameters

[in]	it	Iterator
[out]	data_size	Size of fetched data
[out]	data_type_size	Size of data type
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

◆ fetch_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::fetch_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		unsigned char *	data_buffer,
		size_t	data_buffer_length,
		size_t *	data_size,
		char *	data_type_buffer,
		size_t	data_type_buffer_length,
		size_t *	data_type_size,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Fetches data from keyring.

Parameters

[in]	it	Iterator
[out]	data_buffer	Out buffer for data
[in]	data_buffer_length	Length of out buffer
[out]	data_size	Size of fetched data
[out]	data_type_buffer	Type of data
[in]	data_type_buffer_length	Length of data type buffer
[out]	data_type_size	Size of data type
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

◆ generate_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::generate_template	(	const char *	data_id,
		const char *	auth_id,
		const char *	data_type,
		size_t	data_size,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Generate data and store in keyring.

Parameters

[in]	data_id	Data Identifier
[in]	auth_id	Authorization ID
[in]	data_type	Type of data. Assumed null terminated.
[in]	data_size	Size of the data to be generated
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success - Key generated and stored in keyring.
true	Failure

◆ init_keys_metadata_iterator_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::init_keys_metadata_iterator_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Forward iterator initialization.

Parameters

[out]	it	metadata iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: Status of the operation

Return values

false	Success
true	Failure

◆ init_reader_template()

template<typename Backend , typename Data_extension = data::Data>

int keyring_common::service_implementation::init_reader_template	(	const char *	data_id,
		const char *	auth_id,
		std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Initialize reader.

Parameters

[in]	data_id	Data Identifier
[in]	auth_id	Authorization ID
[out]	it	Iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

-1	Keyring error. reader_object will not be created.
0	Key not found OR error fetching keys. reader_object will not be created.
1	Key found, check out parameters

◆ keyring_metadata_query_deinit_template()

bool keyring_common::service_implementation::keyring_metadata_query_deinit_template ( std::unique_ptr< config_vector > & it )

Deinitialize metadata iterator.

Parameters

[in,out] it Metadata iterator handle

Returns: Status of iterator deinitialization

Return values

false	Success
true	Failure. Check error state.

◆ keyring_metadata_query_get_length_template()

bool keyring_common::service_implementation::keyring_metadata_query_get_length_template	(	std::unique_ptr< config_vector > &	it,
		size_t *	key_buffer_length,
		size_t *	value_buffer_length
	)

Get length information about metadata key and value.

Parameters

[in]	it	Metadata iterator handle
[out]	key_buffer_length	Length of the key buffer
[out]	value_buffer_length	Length of the value buffer

Returns: Get length information about key and value

Return values

false	Success check out parameters
true	Error

◆ keyring_metadata_query_get_template()

bool keyring_common::service_implementation::keyring_metadata_query_get_template	(	char *	key_buffer,
		size_t	key_buffer_length,
		char *	value_buffer,
		size_t	value_buffer_length,
		std::unique_ptr< config_vector > &	it
	)

Get name and value of metadata at current position.

Parameters

[out]	key_buffer	Output buffer for key
[in]	key_buffer_length	Length of key buffer
[out]	value_buffer	Output buffer for value
[in]	value_buffer_length	Length of value buffer
[in]	it	Metadata iterator handle

Returns: Status of fetch operation

Return values

false	Success
true	Failure. Check error state.

◆ keyring_metadata_query_init_template()

bool keyring_common::service_implementation::keyring_metadata_query_init_template	(	std::unique_ptr< config_vector > &	it,
		Component_callbacks &	callbacks
	)

Initialize metadata iterator.

Parameters

[out]	it	Metadata iterator handle
[in]	callbacks	Component callback handle

Returns: Status of iterator initialization

Return values

false	Success
true	Failure. Check error state.

◆ keyring_metadata_query_is_valid_template()

bool keyring_common::service_implementation::keyring_metadata_query_is_valid_template ( std::unique_ptr< config_vector > & it )

Check validity of iterator.

Parameters

[in] it Metadata iterator handle

Returns: Validity of the the iterator

Return values

true	Iterator valid
false	Iterator invalid

◆ keyring_metadata_query_keyring_initialized_template()

bool keyring_common::service_implementation::keyring_metadata_query_keyring_initialized_template ( Component_callbacks & callbacks )

Returns status of the keyring component.

Parameters

[in] callbacks Component specific callbacks

Returns: Status of keyring

Return values

true	Initialized
false	Not initialized

◆ keyring_metadata_query_next_template()

bool keyring_common::service_implementation::keyring_metadata_query_next_template ( std::unique_ptr< config_vector > & it )

Move iterator forward.

Parameters

[in,out] it Metadata iterator handle

Returns: Status of operation

Return values

false	Success
true	Failure.

◆ keys_metadata_get_length_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::keys_metadata_get_length_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		size_t *	data_id_length,
		size_t *	auth_id_length,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Fetch length of metadata for current key pointed by iterator.

Parameters

[out]	it	metadata iterator
[out]	data_id_length	Length of data_id buffer
[out]	auth_id_length	Length of auth_id buffer
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: Status of the operation

Return values

false	Success
true	Failure

◆ keys_metadata_get_template()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::keys_metadata_get_template	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		char *	data_id,
		size_t	data_id_length,
		char *	auth_id,
		size_t	auth_id_length,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Fetch metadata for current key pointed by iterator.

Parameters

[out]	it	metadata iterator
[out]	data_id	ID information of current data
[in]	data_id_length	Length of data_id buffer
[out]	auth_id	Owner of the key
[in]	auth_id_length	Length of auth_id buffer
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: Status of the operation

Return values

false	Success
true	Failure

◆ keys_metadata_iterator_is_valid()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::keys_metadata_iterator_is_valid	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Check validity of the iterator.

Parameters

[in]	it	metadata iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: Validty of the iterator

Return values

true	Iterator is valid
false	Iterator is invalid

◆ keys_metadata_iterator_next()

template<typename Backend , typename Data_extension = Data>

bool keyring_common::service_implementation::keys_metadata_iterator_next	(	std::unique_ptr< Iterator< Data_extension > > &	it,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Move iterator forward.

Parameters

[out]	it	metadata iterator
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Component specific callbacks

Returns: Status of the operation

Return values

false	Success - indicates that iterator is pointing to next entry
true	Failure - indicates that iterator has reached the end

◆ remove_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::remove_template	(	const char *	data_id,
		const char *	auth_id,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Remove data from keyring.

Parameters

[in]	data_id	Data Identifier
[in]	auth_id	Authorization ID
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success - Key removed successfully or key not present.
true	Failure

◆ store_template()

template<typename Backend , typename Data_extension = data::Data>

bool keyring_common::service_implementation::store_template	(	const char *	data_id,
		const char *	auth_id,
		const unsigned char *	data,
		size_t	data_size,
		const char *	data_type,
		Keyring_operations< Backend, Data_extension > &	keyring_operations,
		Component_callbacks &	callbacks
	)

Store data in keyring.

Parameters

[in]	data_id	Data Identifier
[in]	auth_id	Authorization ID
[in]	data	Data to be stored
[in]	data_size	Size of data to be stored
[in]	data_type	Type of data
[in]	keyring_operations	Reference to the object that handles cache and backend
[in]	callbacks	Handle to component specific callbacks

Returns: status of the operation

Return values

false	Success
true	Failure

Classes

Typedefs

Functions

Typedef Documentation

◆ config_vector

Function Documentation

◆ aes_decrypt_template()

◆ aes_encrypt_template()

◆ aes_get_encrypted_size_template()

◆ deinit_keys_metadata_iterator_template()

◆ deinit_reader_template()

◆ fetch_length_template()

◆ fetch_template()

◆ generate_template()

◆ init_keys_metadata_iterator_template()

◆ init_reader_template()

◆ keyring_metadata_query_deinit_template()

◆ keyring_metadata_query_get_length_template()

◆ keyring_metadata_query_get_template()

◆ keyring_metadata_query_init_template()

◆ keyring_metadata_query_is_valid_template()

◆ keyring_metadata_query_keyring_initialized_template()

◆ keyring_metadata_query_next_template()

◆ keys_metadata_get_length_template()

◆ keys_metadata_get_template()

◆ keys_metadata_iterator_is_valid()

◆ keys_metadata_iterator_next()

◆ remove_template()

◆ store_template()