taf_fsc_common.h File Reference

#include "legato.h"

Go to the source code of this file.

Macros
#define	IFGEN_TAF_FSC_PROTOCOL_ID   "d6dc55225e6e52a13de61946788de9b5"
#define	IFGEN_TAF_FSC_MSG_SIZE   268
#define	TAF_FSC_MAX_STORAGE_NAME_SIZE   256

Typedefs
typedef struct taf_fsc_Storage *	taf_fsc_StorageRef_t

Functions
LE_SHARED bool	ifgen_taf_fsc_HasLocalBinding (void)
LE_SHARED void	ifgen_taf_fsc_InitCommonData (void)
LE_SHARED void	ifgen_taf_fsc_CleanupCommonData (le_msg_SessionRef_t _ifgen_sessionRef)
LE_SHARED le_result_t	ifgen_taf_fsc_OpenSession (le_msg_SessionRef_t _ifgen_sessionRef, bool isBlocking)
LE_SHARED taf_fsc_StorageRef_t	ifgen_taf_fsc_GetStorageRef (le_msg_SessionRef_t _ifgen_sessionRef, const char *LE_NONNULL dirPath, le_result_t *resultPtr)
LE_SHARED le_result_t	ifgen_taf_fsc_LockStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_fsc_StorageRef_t StorageRef)
LE_SHARED le_result_t	ifgen_taf_fsc_UnlockStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_fsc_StorageRef_t StorageRef)
LE_SHARED le_result_t	ifgen_taf_fsc_DeleteStorage (le_msg_SessionRef_t _ifgen_sessionRef, taf_fsc_StorageRef_t StorageRef)

Macro Definition Documentation

IFGEN_TAF_FSC_PROTOCOL_ID

#define IFGEN_TAF_FSC_PROTOCOL_ID   "d6dc55225e6e52a13de61946788de9b5"

IFGEN_TAF_FSC_MSG_SIZE

#define IFGEN_TAF_FSC_MSG_SIZE   268

TAF_FSC_MAX_STORAGE_NAME_SIZE

#define TAF_FSC_MAX_STORAGE_NAME_SIZE   256

The maximum size of the directory path in bytes.

Typedef Documentation

taf_fsc_StorageRef_t

typedef struct taf_fsc_Storage* taf_fsc_StorageRef_t

FS-Crypt storage object reference.

Function Documentation

ifgen_taf_fsc_HasLocalBinding()

LE_SHARED bool ifgen_taf_fsc_HasLocalBinding

(

void

)

Get if this client bound locally.

ifgen_taf_fsc_InitCommonData()

LE_SHARED void ifgen_taf_fsc_InitCommonData

(

void

)

Init data that is common across all threads

ifgen_taf_fsc_CleanupCommonData()

LE_SHARED void ifgen_taf_fsc_CleanupCommonData

(

le_msg_SessionRef_t

_ifgen_sessionRef

)

Cleanup the data of a session

ifgen_taf_fsc_OpenSession()

LE_SHARED le_result_t ifgen_taf_fsc_OpenSession	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		bool	isBlocking
	)

Perform common initialization and open a session

ifgen_taf_fsc_GetStorageRef()

LE_SHARED taf_fsc_StorageRef_t ifgen_taf_fsc_GetStorageRef	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		const char *LE_NONNULL	dirPath,
		le_result_t *	resultPtr
	)

Gets the FS-Crypt storage object reference, including initialization for the FS-Crypt directory.

Returns

• Storage – The FS-Crypt storage object reference.
• NULL – Failure in process.

Parameters

[in]	dirPath	Storage name.
[out]	resultPtr	Error status.

ifgen_taf_fsc_LockStorage()

LE_SHARED le_result_t ifgen_taf_fsc_LockStorage	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_fsc_StorageRef_t	StorageRef
	)

Removes an FS-Crypt key from the kernel keyring to lock the directory.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – The key does not exist or is not provisioned.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.

ifgen_taf_fsc_UnlockStorage()

LE_SHARED le_result_t ifgen_taf_fsc_UnlockStorage	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_fsc_StorageRef_t	StorageRef
	)

Adds an FS-Crypt key to the kernel keyring to unlock the directory.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – Key does not exist.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.

ifgen_taf_fsc_DeleteStorage()

LE_SHARED le_result_t ifgen_taf_fsc_DeleteStorage	(	le_msg_SessionRef_t	_ifgen_sessionRef,
		taf_fsc_StorageRef_t	StorageRef
	)

Cleans the entire FS-Crypt directory and encryption key.

Returns

• LE_OK – Succeeded.
• LE_BAD_PARAMETER – Bad parameter(s).
• LE_NOT_FOUND – Key does not exist.
• LE_FAULT – Error in process.

Parameters

[in]

StorageRef

Storage reference.