Cipher, Identity and Protection Mechanisms

Eet allows one to protect entries of an Eet_File individually. More...

Typedefs

typedef struct _Eet_Key Eet_Key
 Opaque handle that defines an identity (also known as key) in Eet's cipher system.
 
typedef int(* Eet_Key_Password_Callback )(char *buffer, int size, int rwflag, void *data)
 Callback used to request if needed the password of a private key. More...
 

Functions

EAPI Eet_Keyeet_identity_open (const char *certificate_file, const char *private_key_file, Eet_Key_Password_Callback cb)
 Create an Eet_Key needed for signing an eet file. More...
 
EAPI void eet_identity_close (Eet_Key *key)
 Close and release all resource used by an Eet_Key. More...
 
EAPI Eet_Error eet_identity_set (Eet_File *ef, Eet_Key *key)
 Set a key to sign a file. More...
 
EAPI void eet_identity_print (Eet_Key *key, FILE *out)
 Display both private and public key of an Eet_Key. More...
 
EAPI const void * eet_identity_x509 (Eet_File *ef, int *der_length)
 Get the x509 der certificate associated with an Eet_File. More...
 
EAPI const void * eet_identity_signature (Eet_File *ef, int *signature_length)
 Get the raw signature associated with an Eet_File. More...
 
EAPI const void * eet_identity_sha1 (Eet_File *ef, int *sha1_length)
 Get the SHA1 associated with a file. More...
 
EAPI void eet_identity_certificate_print (const unsigned char *certificate, int der_length, FILE *out)
 Display the x509 der certificate to out. More...
 

Detailed Description

Eet allows one to protect entries of an Eet_File individually.

This may be used to ensure data was not tampered or that third party does not read your data.

See also
Eet File Ciphered Main Functions
Image Store and Load using a Cipher

Typedef Documentation

typedef int(* Eet_Key_Password_Callback)(char *buffer, int size, int rwflag, void *data)

Callback used to request if needed the password of a private key.

Parameters
bufferthe buffer where to store the password.
sizethe maximum password size (size of buffer, including '\0').
rwflagif the buffer is also readable or just writable.
datacurrently unused, may contain some context in future.
Returns
1 on success and password was set to buffer, 0 on failure.
Since
1.2.0

Function Documentation

EAPI Eet_Key* eet_identity_open ( const char *  certificate_file,
const char *  private_key_file,
Eet_Key_Password_Callback  cb 
)

Create an Eet_Key needed for signing an eet file.

The certificate should provide the public that match the private key. No verification is done to ensure that.

Parameters
certificate_fileThe file where to find the certificate.
private_key_fileThe file that contains the private key.
cbFunction to callback if password is required to unlock private key.
Returns
A key handle to use, or NULL on failure.
See also
eet_identity_close()
Since
1.2.0
EAPI void eet_identity_close ( Eet_Key key)

Close and release all resource used by an Eet_Key.

An reference counter prevent it from being freed until all file using it are also closed.

Parameters
keythe key handle to close and free resources.
Since
1.2.0
EAPI Eet_Error eet_identity_set ( Eet_File ef,
Eet_Key key 
)

Set a key to sign a file.

Parameters
efthe file to set the identity.
keythe key handle to set as identity.
Returns
EET_ERROR_BAD_OBJECT if ef is invalid or EET_ERROR_NONE on success.
Since
1.2.0

References EET_ERROR_BAD_OBJECT, and EET_ERROR_NONE.

EAPI void eet_identity_print ( Eet_Key key,
FILE *  out 
)

Display both private and public key of an Eet_Key.

Parameters
keythe handle to print.
outwhere to print.
Since
1.2.0
EAPI const void* eet_identity_x509 ( Eet_File ef,
int *  der_length 
)

Get the x509 der certificate associated with an Eet_File.

Will return NULL if the file is not signed.

Parameters
efThe file handle to query.
der_lengthThe length of returned data, may be NULL.
Returns
the x509 certificate or NULL on error.
Since
1.2.0
EAPI const void* eet_identity_signature ( Eet_File ef,
int *  signature_length 
)

Get the raw signature associated with an Eet_File.

Will return NULL if the file is not signed.

Parameters
efThe file handle to query.
signature_lengthThe length of returned data, may be NULL.
Returns
the raw signature or NULL on error.
EAPI const void* eet_identity_sha1 ( Eet_File ef,
int *  sha1_length 
)

Get the SHA1 associated with a file.

Could be the one used to sign the data or if the data where not signed, it will be the SHA1 of the file.

Parameters
efThe file handle to query.
sha1_lengthThe length of returned data, may be NULL.
Returns
the associated SHA1 or NULL on error.
Since
1.2.0
EAPI void eet_identity_certificate_print ( const unsigned char *  certificate,
int  der_length,
FILE *  out 
)

Display the x509 der certificate to out.

Parameters
certificatethe x509 certificate to print
der_lengthThe length the certificate.
outwhere to print.
Since
1.2.0