PKCS#12 container is often used in cryptography to store asymmetric key pair. More...

Inheritance diagram for PKCS12KeyHandle:

error_type CALLING_CONVENTION	PKCS12Key_CreateFromFile (string_type path, string_type password, PKCS12KeyHandle **result)
	Uses PKCS#12 standard format to access asymmetric keys. More...

error_type CALLING_CONVENTION	PKCS12Key_CreateFromBuffer (BufferHandle data, string_type password, PKCS12KeyHandle *result)
	Uses PKCS#12 standard format to access asymmetric keys. More...

error_type CALLING_CONVENTION	PKCS12Key_ToEncryptionKey (PKCS12KeyHandle handle, EncryptionKeyHandle *result)
	Reinterpret current object as EncryptionKeyHandle.

error_type CALLING_CONVENTION	PKCS12Key_FromEncryptionKey (EncryptionKeyHandle handle, PKCS12KeyHandle *result)
	Convert SigningKeyHandle to EncryptionKeyHandle.

error_type CALLING_CONVENTION	PKCS12Key_ToSigningKey (PKCS12KeyHandle handle, SigningKeyHandle *result)
	Reinterpret current object as SigningKeyHandle.

error_type CALLING_CONVENTION	PKCS12Key_FromSigningKey (SigningKeyHandle handle, PKCS12KeyHandle *result)
	Convert SigningKeyHandle to PKCS12KeyHandle.

error_type CALLING_CONVENTION	PKCS12Key_Release (PKCS12KeyHandle *handle)
	Decrement the internal reference counter. More...

Additional Inherited Members
Public Types inherited from EncryptionKeyHandle
typedef void(*	EncryptionKeyInitializeFunction) (void)
	Function pointer used to initialize dependencies in order to provide decryption. More...

Public Types inherited from SigningKeyHandle
typedef error_type(CALLING_CONVENTION *	SigningKey_Initialize_Function) (void *user_data, MessageDigestAlgorithmType algorithm)
	Initialize signing engine using selected digest algorithm. More...

Public Member Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_AddRef (IUnknownHandle *handle)
	Increment the internal reference counter.

Related Functions inherited from EncryptionKeyHandle
typedef void(*	EncryptionKeyCleanupFunction) (void)
	Cleanup all dependencies after the decryption process has finished. More...

typedef error_type(*	EncryptionKeyDecryptFunction) (const BufferHandle data, BufferHandle *result)
	User provided function used for decrypting data. More...

typedef error_type(*	EncryptionKeyContainsFunction) (const BufferHandle issuer, const BufferHandle serial, boolean_type *result)
	Function used to determine whether the private key for certificate issued by `issuer` with `serial` is present. More...

error_type CALLING_CONVENTION	EncryptionKey_CreateCustom (EncryptionKeyInitializeFunction initialize, EncryptionKeyCleanupFunction cleanup, EncryptionKeyDecryptFunction decrypt, EncryptionKeyContainsFunction contains, EncryptionKeyHandle **result)
	Creates a custom EncryptionKeyHandle to provide custom decrypt operation.

error_type CALLING_CONVENTION	EncryptionKey_Release (EncryptionKeyHandle *handle)
	Decrement the internal reference counter. More...

Related Functions inherited from IUnknownHandle
error_type CALLING_CONVENTION	IUnknown_Release (IUnknownHandle *handle)
	Decrement the internal reference counter. More...

Related Functions inherited from SigningKeyHandle
typedef error_type(CALLING_CONVENTION *	SigningKey_Update_Function) (void user_data, const BufferHandle data)
	Insert data into engine for digest calculation. More...

typedef error_type(CALLING_CONVENTION *	SigningKey_Final_Function) (void user_data, BufferHandle *result)
	Finish the digest calculation and return signed hash. More...

typedef error_type(CALLING_CONVENTION *	SigningKey_Cleanup_Function) (void *user_data)
	Cleanup all dependencies after the signing process has finished. More...

error_type CALLING_CONVENTION	SigningKey_CreateCustom (SigningKey_Initialize_Function sign_init, SigningKey_Update_Function sign_update, SigningKey_Final_Function sign_final, SigningKey_Cleanup_Function sign_cleanup, void user_data, SigningKeyHandle *result)
	Creates a custom SigningKeyHandle to provide custom sign operation.

error_type CALLING_CONVENTION	SigningKey_ToUnknown (SigningKeyHandle handle, IUnknownHandle *result)
	Reinterpret current object as IUnknownHandle.

error_type CALLING_CONVENTION	SigningKey_FromUnknown (IUnknownHandle handle, SigningKeyHandle *result)
	Convert IUnknownHandle to BufferHandle.

error_type CALLING_CONVENTION	SigningKey_Release (SigningKeyHandle *handle)
	Decrement the internal reference counter. More...

Detailed Description

PKCS#12 container is often used in cryptography to store asymmetric key pair.

It can used for encryption/decryption and signing as well.

Examples: decrypt.c, and sign.c.

Member Function Documentation

◆ PKCS12Key_CreateFromFile()

error_type CALLING_CONVENTION PKCS12Key_CreateFromFile	(	string_type	path,
		string_type	password,
		PKCS12KeyHandle **	result
	)

Uses PKCS#12 standard format to access asymmetric keys.

Parameters

path	a string path to file containing the PKCS#12 data structure
password	a protection password to the data structure. If there is no password use NULL.
result	a pointer to library allocated PKCS12KeyHandle

Examples: decrypt.c, and sign.c.

Friends And Related Function Documentation

◆ PKCS12Key_CreateFromBuffer()

error_type CALLING_CONVENTION PKCS12Key_CreateFromBuffer	(	BufferHandle *	data,
		string_type	password,
		PKCS12KeyHandle **	result
	)

Parameters

data	a buffer containing PKCS#12 data structure
password	a protection password to the data structure. If there is no password use NULL.
result	a pointer to library allocated PKCS12KeyHandle

◆ PKCS12Key_Release()

error_type CALLING_CONVENTION PKCS12Key_Release ( PKCS12KeyHandle * handle )

When the internal counter reaches zero the object is deleted. Releasing already disposed object causes undefined behavior.

See also: IUnknown_Release

Examples: decrypt.c, and sign.c.

The documentation for this class was generated from the following file: