virtru_encrypt_string_params_c.h File Reference

#include "virtru_constants_c.h"

Go to the source code of this file.

Functions
DLL_PUBLIC VEncryptStringParamsPtr	VEncryptStringParamsCreate (VCBytesPtr vBytesPtr, VBytesLength vBytesLength)
DLL_PUBLIC void	VEncryptStringParamsDestroy (VEncryptStringParamsPtr vEncryptStringParamsPtr)
DLL_PUBLIC VSTATUS	VEncryptStringParamsSetMimeType (VEncryptStringParamsPtr vEncryptStringParamsPtr, const char *mimeType)
DLL_PUBLIC VSTATUS	VEncryptStringParamsSetPolicy (VEncryptStringParamsPtr vEncryptStringParamsPtr, VPolicyPtr vPolicyPtr)
DLL_PUBLIC VSTATUS	VEncryptStringParamsSetDisplayName (VEncryptStringParamsPtr vEncryptStringParamsPtr, const char *displayName)
DLL_PUBLIC VSTATUS	VEncryptStringParamsSetDisplayMessage (VEncryptStringParamsPtr vEncryptStringParamsPtr, const char *displayMessage)
DLL_PUBLIC VSTATUS	VEncryptStringParamsShareWithUsers (VEncryptStringParamsPtr vEncryptStringParamsPtr, const char **users, unsigned int usersCount)

Function Documentation

DLL_PUBLIC VEncryptStringParamsPtr VEncryptStringParamsCreate	(	VCBytesPtr	vBytesPtr,
		VBytesLength	vBytesLength
	)

Create a new encrypt string param opaque object.

Parameters

vBytesPtr	- Const pointer to the data buffer.
vBytesLength	- The file on which the encryption is performed

Returns

VEncryptStringParams opaque object. NOTE: On failure returns NULL ptr.

DLL_PUBLIC void VEncryptStringParamsDestroy

(

VEncryptStringParamsPtr

vEncryptStringParamsPtr

)

Destruct the EncryptStringParams instance.

Parameters

vEncryptStringParamsPtr

- The pointer to EncryptStringParams opaque object.

DLL_PUBLIC VSTATUS VEncryptStringParamsSetDisplayMessage	(	VEncryptStringParamsPtr	vEncryptStringParamsPtr,
		const char *	displayMessage
	)

Set the display message for the tdf, this message shows up on the Virtru dashboard

Parameters

vEncryptStringParamsPtr	- The pointer to EncryptStringParams opaque object.
displayMessage	- The display message for the tdf, null terminated string.

Returns

VSTATUS - VSTATUS_SUCCESS on success

DLL_PUBLIC VSTATUS VEncryptStringParamsSetDisplayName	(	VEncryptStringParamsPtr	vEncryptStringParamsPtr,
		const char *	displayName
	)

Set the display name for the tdf, this name shows up on the Virtru dashboard NOTE: If not set, the basename of inFilePath will be used

Parameters

vEncryptStringParamsPtr	- The pointer to EncryptStringParams opaque object.
displayName	- The display name for the tdf, null terminated string.

Returns

VSTATUS - VSTATUS_SUCCESS on success

DLL_PUBLIC VSTATUS VEncryptStringParamsSetMimeType	(	VEncryptStringParamsPtr	vEncryptStringParamsPtr,
		const char *	mimeType
	)

The below methods are optional, if not specified the defaults are used.Set the mime type (format) of the file that will be encrypted NOTE: The default will be 'application/octet-stream' if not specified

Parameters

vEncryptStringParamsPtr	- The pointer to EncryptStringParams opaque object.
mimeType	- The mime type of the file, null terminated string.

Returns

VSTATUS - VSTATUS_SUCCESS on success

DLL_PUBLIC VSTATUS VEncryptStringParamsSetPolicy	(	VEncryptStringParamsPtr	vEncryptStringParamsPtr,
		VPolicyPtr	vPolicyPtr
	)

Set the policy that to be applied to the tdf NOTE: If there is no policy defined for the tdf, default policy settings will be applied

Parameters

vEncryptStringParamsPtr	- The pointer to EncryptStringParams opaque object.
vPolicyPtr	- The pointer to policy opaque object.

Returns

VSTATUS - VSTATUS_SUCCESS on success

DLL_PUBLIC VSTATUS VEncryptStringParamsShareWithUsers	(	VEncryptStringParamsPtr	vEncryptStringParamsPtr,
		const char **	users,
		unsigned int	usersCount
	)

Add access to the TDF file/data for the users in the list

Parameters

vEncryptStringParamsPtr	- The pointer to EncryptStringParams opaque object.
users	- Share the TDF with the users in the users array
usersCount	- Total user count in the array.

Returns

VSTATUS - VSTATUS_SUCCESS on success