Vanilla.PDF  1.5.1
Cross-platform toolkit for creating and modifying PDF documents
List of all members
PKCS12KeyHandle Class Reference

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

Inheritance diagram for PKCS12KeyHandle:
EncryptionKeyHandle SigningKeyHandle IUnknownHandle IUnknownHandle
error_type PKCS12Key_CreateFromFile (string_type path, string_type password, PKCS12KeyHandle **result)
 Uses PKCS#12 standard format to access asymmetric keys. More...
 
error_type PKCS12Key_CreateFromBuffer (BufferHandle *data, string_type password, PKCS12KeyHandle **result)
 Uses PKCS#12 standard format to access asymmetric keys. More...
 
error_type PKCS12Key_ToEncryptionKey (PKCS12KeyHandle *handle, EncryptionKeyHandle **result)
 Reinterpret current object as EncryptionKeyHandle.
 
error_type PKCS12Key_FromEncryptionKey (EncryptionKeyHandle *handle, PKCS12KeyHandle **result)
 Convert SigningKeyHandle to EncryptionKeyHandle.
 
error_type PKCS12Key_ToSigningKey (PKCS12KeyHandle *handle, SigningKeyHandle **result)
 Reinterpret current object as SigningKeyHandle.
 
error_type PKCS12Key_FromSigningKey (SigningKeyHandle *handle, PKCS12KeyHandle **result)
 Convert SigningKeyHandle to PKCS12KeyHandle.
 
error_type 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(* SigningKey_Initialize_Function) (void *user_data, MessageDigestAlgorithmType algorithm)
 Initialize signing engine using selected digest algorithm. More...
 
- Public Member Functions inherited from IUnknownHandle
error_type IUnknown_AddRef (IUnknownHandle *handle)
 Increment the internal reference counter.
 

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 PKCS12Key_CreateFromFile ( string_type  path,
string_type  password,
PKCS12KeyHandle **  result 
)

Uses PKCS#12 standard format to access asymmetric keys.

Parameters
patha string path to file containing the PKCS#12 data structure
passworda protection password to the data structure. If there is no password use NULL.
resulta pointer to library allocated PKCS12KeyHandle
Examples:
decrypt.c, and sign.c.

Friends And Related Function Documentation

◆ PKCS12Key_CreateFromBuffer()

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

Uses PKCS#12 standard format to access asymmetric keys.

Parameters
dataa buffer containing PKCS#12 data structure
passworda protection password to the data structure. If there is no password use NULL.
resulta pointer to library allocated PKCS12KeyHandle

◆ PKCS12Key_Release()

error_type PKCS12Key_Release ( PKCS12KeyHandle handle)
related

Decrement the internal reference counter.

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: