Files
file	pkcs11-helper-1.0/pkcs11h-certificate.h
	pkcs11-helper certificate functions.

Classes
struct	pkcs11h_certificate_id_s
	Certificate id reference. More...
struct	pkcs11h_certificate_id_list_s
	Certificate id list. More...

Typedefs
typedef struct pkcs11h_certificate_id_s *	pkcs11h_certificate_id_t
	Certificate id reference.
typedef struct pkcs11h_certificate_s *	pkcs11h_certificate_t
	Certificate object.
typedef struct pkcs11h_certificate_id_list_s *	pkcs11h_certificate_id_list_t
	Certificate id list.

Functions
CK_RV	pkcs11h_certificate_freeCertificateId (IN pkcs11h_certificate_id_t certificate_id)
	Free certificate_id object.
CK_RV	pkcs11h_certificate_duplicateCertificateId (OUT pkcs11h_certificate_id_t *const to, IN const pkcs11h_certificate_id_t from)
	Duplicate certificate_id object.
CK_RV	pkcs11h_certificate_setCertificateIdCertificateBlob (IN const pkcs11h_certificate_id_t certificate_id, IN const unsigned char *const blob, IN const size_t blob_size)
	Sets internal certificate_id blob.
CK_RV	pkcs11h_certificate_freeCertificate (IN pkcs11h_certificate_t certificate)
	Free certificate object.
CK_RV	pkcs11h_certificate_create (IN const pkcs11h_certificate_id_t certificate_id, IN void const user_data, IN const unsigned mask_prompt, IN const int pin_cache_period, OUT pkcs11h_certificate_t const p_certificate)
	Create a certificate object out of certificate_id.
unsigned	pkcs11h_certificate_getPromptMask (IN const pkcs11h_certificate_t certificate)
	Extract user data out of certificate.
void	pkcs11h_certificate_setPromptMask (IN const pkcs11h_certificate_t certificate, IN const unsigned mask_prompt)
	Extract user data out of certificate.
void *	pkcs11h_certificate_getUserData (IN const pkcs11h_certificate_t certificate)
	Extract user data out of certificate.
void	pkcs11h_certificate_setUserData (IN const pkcs11h_certificate_t certificate, IN void *const user_data)
	Extract user data out of certificate.
CK_RV	pkcs11h_certificate_getCertificateId (IN const pkcs11h_certificate_t certificate, OUT pkcs11h_certificate_id_t *const p_certificate_id)
	Get certificate id object out of a certificate.
CK_RV	pkcs11h_certificate_getCertificateBlob (IN const pkcs11h_certificate_t certificate, OUT unsigned char const certificate_blob, IN OUT size_t const p_certificate_blob_size)
	Get the certificate blob out of the certificate object.
CK_RV	pkcs11h_certificate_serializeCertificateId (OUT char const sz, IN OUT size_t max, IN const pkcs11h_certificate_id_t certificate_id)
	Serialize certificate_id into a string.
CK_RV	pkcs11h_certificate_deserializeCertificateId (OUT pkcs11h_certificate_id_t const p_certificate_id, IN const char const sz)
	Deserialize certificate_id out of string.
CK_RV	pkcs11h_certificate_ensureCertificateAccess (IN const pkcs11h_certificate_t certificate)
	Ensure certificate is accessible.
CK_RV	pkcs11h_certificate_ensureKeyAccess (IN const pkcs11h_certificate_t certificate)
	Ensure key is accessible.
CK_RV	pkcs11h_certificate_lockSession (IN const pkcs11h_certificate_t certificate)
	Lock session for threaded environment.
CK_RV	pkcs11h_certificate_releaseSession (IN const pkcs11h_certificate_t certificate)
	Releases session lock.
CK_RV	pkcs11h_certificate_sign (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Sign data.
CK_RV	pkcs11h_certificate_sign_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Sign data with mechanism parameters.
CK_RV	pkcs11h_certificate_signRecover (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Sign data.
CK_RV	pkcs11h_certificate_signRecover_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Sign data with mechanism parameters.
CK_RV	pkcs11h_certificate_decrypt (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Decrypt data.
CK_RV	pkcs11h_certificate_decrypt_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Decrypt data with mechanism parameters.
CK_RV	pkcs11h_certificate_unwrap (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Decrypt data.
CK_RV	pkcs11h_certificate_unwrap_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Decrypt data with mechanism parameters.
CK_RV	pkcs11h_certificate_signAny (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Sign data with method determined by key attributes.
CK_RV	pkcs11h_certificate_signAny_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Sign data with method determined by key attributes.
CK_RV	pkcs11h_certificate_decryptAny (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM_TYPE mech_type, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t *const p_target_size)
	Decrypt data with method determined by key attributes.
CK_RV	pkcs11h_certificate_decryptAny_ex (IN const pkcs11h_certificate_t certificate, IN const CK_MECHANISM const mech, IN const unsigned char const source, IN const size_t source_size, OUT unsigned char const target, IN OUT size_t const p_target_size)
	Decrypt data with method determined by key attributes.
CK_RV	pkcs11h_certificate_freeCertificateIdList (IN const pkcs11h_certificate_id_list_t cert_id_list)
	Free certificate_id list.
CK_RV	pkcs11h_certificate_enumTokenCertificateIds (IN const pkcs11h_token_id_t token_id, IN const unsigned method, IN void const user_data, IN const unsigned mask_prompt, OUT pkcs11h_certificate_id_list_t const p_cert_id_issuers_list, OUT pkcs11h_certificate_id_list_t *const p_cert_id_end_list)
	Enumerate available certificates on specific token.
CK_RV	pkcs11h_certificate_enumCertificateIds (IN const unsigned method, IN void const user_data, IN const unsigned mask_prompt, OUT pkcs11h_certificate_id_list_t const p_cert_id_issuers_list, OUT pkcs11h_certificate_id_list_t *const p_cert_id_end_list)
	Enumerate available certificates.

Detailed Description

X.509 certificate interface, provides signature and decryption.

Function Documentation

◆ pkcs11h_certificate_create()

CK_RV pkcs11h_certificate_create	(	IN const pkcs11h_certificate_id_t	certificate_id,
		IN void *const	user_data,
		IN const unsigned	mask_prompt,
		IN const int	pin_cache_period,
		OUT pkcs11h_certificate_t *const	p_certificate )

Create a certificate object out of certificate_id.

Parameters

certificate_id	Certificate id object to be based on.
user_data	Optional user data, to be passed to hooks.
mask_prompt	Allow prompt PKCS11H_PROMPT_MASK.
pin_cache_period	Session specific cache period.
p_certificate	Receives certificate object.

Note: Caller must free result.

See also: pkcs11h_certificate_freeCertificate().

Remarks: The certificate id object may not specify the certificate blob.

Examples: test-certificate.c.

References pkcs11h_certificate_create().

Referenced by pkcs11h_certificate_create().

◆ pkcs11h_certificate_decrypt()

CK_RV pkcs11h_certificate_decrypt	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_decrypt().

Referenced by pkcs11h_certificate_decrypt().

◆ pkcs11h_certificate_decrypt_ex()

CK_RV pkcs11h_certificate_decrypt_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data with mechanism parameters.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_decrypt_ex().

Referenced by pkcs11h_certificate_decrypt_ex().

◆ pkcs11h_certificate_decryptAny()

CK_RV pkcs11h_certificate_decryptAny	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data with method determined by key attributes.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_decryptAny().

Referenced by pkcs11h_certificate_decryptAny().

◆ pkcs11h_certificate_decryptAny_ex()

CK_RV pkcs11h_certificate_decryptAny_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data with method determined by key attributes.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_decryptAny_ex().

Referenced by pkcs11h_certificate_decryptAny_ex().

◆ pkcs11h_certificate_deserializeCertificateId()

CK_RV pkcs11h_certificate_deserializeCertificateId	(	OUT pkcs11h_certificate_id_t *const	p_certificate_id,
		IN const char *const	sz )

Deserialize certificate_id out of string.

Parameters

p_certificate_id	id.
sz	Input string

Returns: CK_RV.

Note: Caller must free result.

See also: pkcs11h_certificate_freeCertificateId().

References pkcs11h_certificate_deserializeCertificateId().

Referenced by pkcs11h_certificate_deserializeCertificateId().

◆ pkcs11h_certificate_duplicateCertificateId()

CK_RV pkcs11h_certificate_duplicateCertificateId	(	OUT pkcs11h_certificate_id_t *const	to,
		IN const pkcs11h_certificate_id_t	from )

Duplicate certificate_id object.

Parameters

to	Target.
from	Source.

Returns: CK_RV.

Note: Caller must free result.

See also: pkcs11h_certificate_freeCertificateId().

References pkcs11h_certificate_duplicateCertificateId().

Referenced by pkcs11h_certificate_duplicateCertificateId().

◆ pkcs11h_certificate_ensureCertificateAccess()

CK_RV pkcs11h_certificate_ensureCertificateAccess ( IN const pkcs11h_certificate_t certificate )

Ensure certificate is accessible.

Parameters

certificate Certificate object.

Returns: CK_RV.

References pkcs11h_certificate_ensureCertificateAccess().

Referenced by pkcs11h_certificate_ensureCertificateAccess().

◆ pkcs11h_certificate_ensureKeyAccess()

CK_RV pkcs11h_certificate_ensureKeyAccess ( IN const pkcs11h_certificate_t certificate )

Ensure key is accessible.

Parameters

certificate Certificate object.

Returns: CK_RV.

References pkcs11h_certificate_ensureKeyAccess().

Referenced by pkcs11h_certificate_ensureKeyAccess().

◆ pkcs11h_certificate_enumCertificateIds()

CK_RV pkcs11h_certificate_enumCertificateIds	(	IN const unsigned	method,
		IN void *const	user_data,
		IN const unsigned	mask_prompt,
		OUT pkcs11h_certificate_id_list_t *const	p_cert_id_issuers_list,
		OUT pkcs11h_certificate_id_list_t *const	p_cert_id_end_list )

Enumerate available certificates.

Parameters

method	How to fetch certificates PKCS11H_ENUM_METHOD.
user_data	Some user specific data.
mask_prompt	Allow prompt PKCS11H_PROMPT_MASK.
p_cert_id_issuers_list	Receives issues list.
p_cert_id_end_list	Receives end certificates list.

Note: p_cert_id_issuers_list may be NULL.; Caller must free result.; This function will likely take long time.

See also: pkcs11h_certificate_freeCertificateIdList().

Examples: test-certificate.c.

References pkcs11h_certificate_enumCertificateIds().

Referenced by pkcs11h_certificate_enumCertificateIds().

◆ pkcs11h_certificate_enumTokenCertificateIds()

CK_RV pkcs11h_certificate_enumTokenCertificateIds	(	IN const pkcs11h_token_id_t	token_id,
		IN const unsigned	method,
		IN void *const	user_data,
		IN const unsigned	mask_prompt,
		OUT pkcs11h_certificate_id_list_t *const	p_cert_id_issuers_list,
		OUT pkcs11h_certificate_id_list_t *const	p_cert_id_end_list )

Enumerate available certificates on specific token.

Parameters

token_id	Token id to enum.
method	How to fetch certificates PKCS11H_ENUM_METHOD.
user_data	Some user specific data.
mask_prompt	Allow prompt PKCS11H_PROMPT_MASK.
p_cert_id_issuers_list	Receives issues list.
p_cert_id_end_list	Receives end certificates list.

Returns: CK_RV.

Note: p_cert_id_issuers_list may be NULL.; Caller must free result.; This function will likely take long time.

See also: pkcs11h_certificate_freeCertificateIdList().

References pkcs11h_certificate_enumTokenCertificateIds().

Referenced by pkcs11h_certificate_enumTokenCertificateIds().

◆ pkcs11h_certificate_freeCertificate()

CK_RV pkcs11h_certificate_freeCertificate ( IN pkcs11h_certificate_t certificate )

Free certificate object.

Parameters

certificate Certificate object.

Returns: CK_RV.

Examples: test-certificate.c.

References pkcs11h_certificate_freeCertificate().

Referenced by pkcs11h_certificate_freeCertificate().

◆ pkcs11h_certificate_freeCertificateId()

CK_RV pkcs11h_certificate_freeCertificateId ( IN pkcs11h_certificate_id_t certificate_id )

Free certificate_id object.

Parameters

certificate_id Certificate id.

Returns: CK_RV.

References pkcs11h_certificate_freeCertificateId().

Referenced by pkcs11h_certificate_freeCertificateId().

◆ pkcs11h_certificate_freeCertificateIdList()

CK_RV pkcs11h_certificate_freeCertificateIdList ( IN const pkcs11h_certificate_id_list_t cert_id_list )

Free certificate_id list.

Parameters

cert_id_list List.

Returns: CK_RV.

Examples: test-certificate.c.

References pkcs11h_certificate_freeCertificateIdList().

Referenced by pkcs11h_certificate_freeCertificateIdList().

◆ pkcs11h_certificate_getCertificateBlob()

CK_RV pkcs11h_certificate_getCertificateBlob	(	IN const pkcs11h_certificate_t	certificate,
		OUT unsigned char *const	certificate_blob,
		IN OUT size_t *const	p_certificate_blob_size )

Get the certificate blob out of the certificate object.

Parameters

certificate	Certificate object.
certificate_blob	Buffer.
p_certificate_blob_size	Buffer size.

Returns: CK_RV.

Note: certificate_blob may be NULL in order to get size.

References pkcs11h_certificate_getCertificateBlob().

Referenced by pkcs11h_certificate_getCertificateBlob().

◆ pkcs11h_certificate_getCertificateId()

CK_RV pkcs11h_certificate_getCertificateId	(	IN const pkcs11h_certificate_t	certificate,
		OUT pkcs11h_certificate_id_t *const	p_certificate_id )

Get certificate id object out of a certificate.

Parameters

certificate	Certificate object.
p_certificate_id	Certificate id object pointer.

Returns: CK_RV.

Note: Caller must free result.

See also: pkcs11h_certificate_freeCertificateId().

References pkcs11h_certificate_getCertificateId().

Referenced by pkcs11h_certificate_getCertificateId().

◆ pkcs11h_certificate_getPromptMask()

unsigned pkcs11h_certificate_getPromptMask ( IN const pkcs11h_certificate_t certificate )

Extract user data out of certificate.

Parameters

certificate Certificate object.

Returns: Mask prompt PKCS11H_PROMPT_MASK.

References pkcs11h_certificate_getPromptMask().

Referenced by pkcs11h_certificate_getPromptMask().

◆ pkcs11h_certificate_getUserData()

void * pkcs11h_certificate_getUserData ( IN const pkcs11h_certificate_t certificate )

Extract user data out of certificate.

Parameters

certificate Certificate object.

Returns: User data.

References pkcs11h_certificate_getUserData().

Referenced by pkcs11h_certificate_getUserData().

◆ pkcs11h_certificate_lockSession()

CK_RV pkcs11h_certificate_lockSession ( IN const pkcs11h_certificate_t certificate )

Lock session for threaded environment.

Parameters

certificate Certificate object.

Returns: CK_RV.

Remarks: This must be called on threaded environment, so both calls to _sign and _signRecover and _decrypt will be from the same source. Failing to lock session, will result with CKR_OPERATION_ACTIVE if provider is good, or unexpected behaviour for others.; It is save to call this also in none threaded environment, it will do nothing. Call this also if you are doing one stage operation, since locking is not done by method.

References pkcs11h_certificate_lockSession().

Referenced by pkcs11h_certificate_lockSession().

◆ pkcs11h_certificate_releaseSession()

CK_RV pkcs11h_certificate_releaseSession ( IN const pkcs11h_certificate_t certificate )

Releases session lock.

Parameters

certificate Certificate object.

Returns: CK_RV.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_releaseSession().

Referenced by pkcs11h_certificate_releaseSession().

◆ pkcs11h_certificate_serializeCertificateId()

CK_RV pkcs11h_certificate_serializeCertificateId	(	OUT char *const	sz,
		IN OUT size_t *	max,
		IN const pkcs11h_certificate_id_t	certificate_id )

Serialize certificate_id into a string.

Parameters

sz	Output string.
max	Max buffer size.
certificate_id	id to serialize

Returns: CK_RV.

Note: sz may be NULL in order to get size.

References pkcs11h_certificate_serializeCertificateId().

Referenced by pkcs11h_certificate_serializeCertificateId().

◆ pkcs11h_certificate_setCertificateIdCertificateBlob()

CK_RV pkcs11h_certificate_setCertificateIdCertificateBlob	(	IN const pkcs11h_certificate_id_t	certificate_id,
		IN const unsigned char *const	blob,
		IN const size_t	blob_size )

Sets internal certificate_id blob.

Parameters

certificate_id	Certificate id object.
blob	Certificate blob.
blob_size	Certificate blob size.

Returns: CK_RV.

Remarks: Useful to set after deserialization so certificate is available and not read from token.

References pkcs11h_certificate_setCertificateIdCertificateBlob().

Referenced by pkcs11h_certificate_setCertificateIdCertificateBlob().

◆ pkcs11h_certificate_setPromptMask()

void pkcs11h_certificate_setPromptMask	(	IN const pkcs11h_certificate_t	certificate,
		IN const unsigned	mask_prompt )

Extract user data out of certificate.

Parameters

certificate	Certificate object.
mask_prompt	Allow prompt PKCS11H_PROMPT_MASK.

References pkcs11h_certificate_setPromptMask().

Referenced by pkcs11h_certificate_setPromptMask().

◆ pkcs11h_certificate_setUserData()

void pkcs11h_certificate_setUserData	(	IN const pkcs11h_certificate_t	certificate,
		IN void *const	user_data )

Extract user data out of certificate.

Parameters

certificate	Certificate object.
user_data	Optional user data, to be passed to hooks.

References pkcs11h_certificate_setUserData().

Referenced by pkcs11h_certificate_setUserData().

◆ pkcs11h_certificate_sign()

CK_RV pkcs11h_certificate_sign	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().; pkcs11h_certificate_signAny().

References pkcs11h_certificate_sign().

Referenced by pkcs11h_certificate_sign().

◆ pkcs11h_certificate_sign_ex()

CK_RV pkcs11h_certificate_sign_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data with mechanism parameters.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().; pkcs11h_certificate_signAny().

References pkcs11h_certificate_sign_ex().

Referenced by pkcs11h_certificate_sign_ex().

◆ pkcs11h_certificate_signAny()

CK_RV pkcs11h_certificate_signAny	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data with method determined by key attributes.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

Examples: test-certificate.c.

References pkcs11h_certificate_signAny().

Referenced by pkcs11h_certificate_signAny().

◆ pkcs11h_certificate_signAny_ex()

CK_RV pkcs11h_certificate_signAny_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data with method determined by key attributes.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_signAny_ex().

Referenced by pkcs11h_certificate_signAny_ex().

◆ pkcs11h_certificate_signRecover()

CK_RV pkcs11h_certificate_signRecover	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().; pkcs11h_certificate_signAny().

References pkcs11h_certificate_signRecover().

Referenced by pkcs11h_certificate_signRecover().

◆ pkcs11h_certificate_signRecover_ex()

CK_RV pkcs11h_certificate_signRecover_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Sign data with mechanism parameters.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().; pkcs11h_certificate_signAny().

References pkcs11h_certificate_signRecover_ex().

Referenced by pkcs11h_certificate_signRecover_ex().

◆ pkcs11h_certificate_unwrap()

CK_RV pkcs11h_certificate_unwrap	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM_TYPE	mech_type,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data.

Parameters

certificate	Certificate object.
mech_type	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_unwrap().

Referenced by pkcs11h_certificate_unwrap().

◆ pkcs11h_certificate_unwrap_ex()

CK_RV pkcs11h_certificate_unwrap_ex	(	IN const pkcs11h_certificate_t	certificate,
		IN const CK_MECHANISM *const	mech,
		IN const unsigned char *const	source,
		IN const size_t	source_size,
		OUT unsigned char *const	target,
		IN OUT size_t *const	p_target_size )

Decrypt data with mechanism parameters.

Parameters

certificate	Certificate object.
mech	PKCS#11 mechanism type.
source	Buffer to sign.
source_size	Buffer size.
target	Target buffer.
p_target_size	Target buffer size.

Returns: CK_RV.

Note: target may be NULL to get size.

Attention: When using in threaded environment session must be locked.

See also: pkcs11h_certificate_lockSession().

References pkcs11h_certificate_unwrap_ex().

Referenced by pkcs11h_certificate_unwrap_ex().

Files

Classes

Typedefs

Functions

Detailed Description

Function Documentation

◆ pkcs11h_certificate_create()

◆ pkcs11h_certificate_decrypt()

◆ pkcs11h_certificate_decrypt_ex()

◆ pkcs11h_certificate_decryptAny()

◆ pkcs11h_certificate_decryptAny_ex()

◆ pkcs11h_certificate_deserializeCertificateId()

◆ pkcs11h_certificate_duplicateCertificateId()

◆ pkcs11h_certificate_ensureCertificateAccess()

◆ pkcs11h_certificate_ensureKeyAccess()

◆ pkcs11h_certificate_enumCertificateIds()

◆ pkcs11h_certificate_enumTokenCertificateIds()

◆ pkcs11h_certificate_freeCertificate()

◆ pkcs11h_certificate_freeCertificateId()

◆ pkcs11h_certificate_freeCertificateIdList()

◆ pkcs11h_certificate_getCertificateBlob()

◆ pkcs11h_certificate_getCertificateId()

◆ pkcs11h_certificate_getPromptMask()

◆ pkcs11h_certificate_getUserData()

◆ pkcs11h_certificate_lockSession()

◆ pkcs11h_certificate_releaseSession()

◆ pkcs11h_certificate_serializeCertificateId()

◆ pkcs11h_certificate_setCertificateIdCertificateBlob()

◆ pkcs11h_certificate_setPromptMask()

◆ pkcs11h_certificate_setUserData()

◆ pkcs11h_certificate_sign()

◆ pkcs11h_certificate_sign_ex()

◆ pkcs11h_certificate_signAny()

◆ pkcs11h_certificate_signAny_ex()

◆ pkcs11h_certificate_signRecover()

◆ pkcs11h_certificate_signRecover_ex()

◆ pkcs11h_certificate_unwrap()

◆ pkcs11h_certificate_unwrap_ex()