SOPC_PKIProvider Struct Reference

The PKIProvider object defines the common interface for the Public Key Infrastructure. More...

#include <sopc_pki.h>

Data Fields
SOPC_PKIProvider_Free_Func *const	pFnFree
	The free function, called upon generic SOPC_PKIProvider destruction. More...
SOPC_FnValidateCertificate *const	pFnValidateCertificate
	The validation function, which is wrapped by SOPC_CryptoProvider_Certificate_Validate(). More...
void *	pTrustedIssuerRootsList
	Placeholder for CAs of trusted issuer roots (only roots, not links). More...
void *	pTrustedIssuerLinksList
	Placeholder for CAs of trusted issuers links (between a certificate to validate and a root). More...
void *	pUntrustedIssuerRootsList
	Placeholder for CAs of untrusted issuer roots (CAs used to validate issued certififcates, only roots). More...
void *	pUntrustedIssuerLinksList
	Placeholder for CAs of untrusted issuers links (between a certificate to validate and a root). More...
void *	pIssuedCertsList
	Placeholder for issued certificates that are trusted on a one by one basis. More...
void *	pCertRevocList
	PKI implementations can use this placeholder to store handles to certificate revocation list(s). More...
void *	pUserData
	PKI implementations can use this placeholder to store more specific data. More...

Detailed Description

The PKIProvider object defines the common interface for the Public Key Infrastructure.

Field Documentation

pFnFree

SOPC_PKIProvider_Free_Func* const SOPC_PKIProvider::pFnFree

The free function, called upon generic SOPC_PKIProvider destruction.

pFnValidateCertificate

SOPC_FnValidateCertificate* const SOPC_PKIProvider::pFnValidateCertificate

The validation function, which is wrapped by SOPC_CryptoProvider_Certificate_Validate().

It implements the validation of the certificate. The SOPC_CryptoProvider_Certificate_Validate() assumes that a SOPC_STATUS_OK from this function means that the certificate can be trusted. Parameters are validated by SOPC_CryptoProvider_Certificate_Validate().

Parameters

pPKI	A valid pointer to the PKIProvider.
pToValidate	A valid pointer to the Certificate to validate.

Returns

SOPC_STATUS_OK when the certificate is successfully validated, and SOPC_STATUS_INVALID_PARAMETERS or SOPC_STATUS_NOK.

pTrustedIssuerRootsList

void* SOPC_PKIProvider::pTrustedIssuerRootsList

Placeholder for CAs of trusted issuer roots (only roots, not links).

pTrustedIssuerLinksList

void* SOPC_PKIProvider::pTrustedIssuerLinksList

Placeholder for CAs of trusted issuers links (between a certificate to validate and a root).

pUntrustedIssuerRootsList

void* SOPC_PKIProvider::pUntrustedIssuerRootsList

Placeholder for CAs of untrusted issuer roots (CAs used to validate issued certififcates, only roots).

pUntrustedIssuerLinksList

void* SOPC_PKIProvider::pUntrustedIssuerLinksList

Placeholder for CAs of untrusted issuers links (between a certificate to validate and a root).

pIssuedCertsList

void* SOPC_PKIProvider::pIssuedCertsList

Placeholder for issued certificates that are trusted on a one by one basis.

pCertRevocList

void* SOPC_PKIProvider::pCertRevocList

PKI implementations can use this placeholder to store handles to certificate revocation list(s).

pUserData

void* SOPC_PKIProvider::pUserData

PKI implementations can use this placeholder to store more specific data.

---

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

• /builds/systerel/S2OPC/src/Common/crypto/sopc_pki.h