eID middleware |

# eIDMW::PTEID_Certificate Class Reference

Class that represent one certificate. More...

`#include <eidlib.h>`

Inheritance diagram for eIDMW::PTEID_Certificate:

List of all members.

## Public Member Functions
virtual PTEIDSDK_API | ~PTEID_Certificate ()
| Destructor.
PTEIDSDK_API const char * | getLabel ()
| Return the label of the certificate.
PTEIDSDK_API unsigned long | getID ()
| Return the id of the certificate.
PTEIDSDK_API PTEID_CertifStatus | getStatus ()
| Return the status of the certificate using default validation level (from config).
PTEIDSDK_API PTEID_CertifStatus | getStatus (PTEID_ValidationLevel crl, PTEID_ValidationLevel ocsp)
| Return the status of the certificate.
PTEIDSDK_API PTEID_CertifType | getType ()
| Return the type of the certificate.
PTEIDSDK_API const PTEID_ByteArray & | getCertData ()
| Return the content of the certificate.
PTEIDSDK_API void | getFormattedData (PTEID_ByteArray &data)
| Return the content of the certificate without ending zero.
PTEIDSDK_API const char * | getSerialNumber ()
| Return the serial number of the certificate.
PTEIDSDK_API const char * | getOwnerName ()
| Return the name of the owner of the certificate.
PTEIDSDK_API const char * | getIssuerName ()
| Return the name of the issuer of the certificate.
PTEIDSDK_API const char * | getValidityBegin ()
| Return the validity begin date of the certificate.
PTEIDSDK_API const char * | getValidityEnd ()
| Return the validity end date of the certificate.
PTEIDSDK_API unsigned long | getKeyLength ()
| Return the length of public/private key on the certificate.
PTEIDSDK_API bool | isRoot ()
| Return true if this is a root certificate.
PTEIDSDK_API bool | isTest ()
| Return the test status.
PTEIDSDK_API bool | isFromPteidValidChain ()
| Return true if the certificate chain end by the one of pteid root.
PTEIDSDK_API bool | isFromCard ()
| This certificate comes from the card.
PTEIDSDK_API PTEID_Certificate & | getIssuer ()
| Return the issuer certificate.
PTEIDSDK_API unsigned long | countChildren ()
| Return the number of children for this certificate.
PTEIDSDK_API PTEID_Certificate & | getChildren (unsigned long ulIndex)
| Return the children certificate (certificate that has been issued by this one).
PTEIDSDK_API PTEID_Crl & | getCRL ()
| Return the crl of the certificate.
PTEIDSDK_API PTEID_OcspResponse & | getOcspResponse ()
| Return the ocsp response object of the certificate.
PTEIDSDK_API PTEID_CertifStatus | verifyCRL (bool forceDownload=false)
| Verify the certificate trough CRL validation.
PTEIDSDK_API PTEID_CertifStatus | verifyOCSP ()
| Verify the certificate trough OCSP validation.
## Friends
PTEID_Certificate & | PTEID_Certificates::getCert (unsigned long ulIndex)
| For internal use : This method must access protected constructor.
PTEID_Certificate & | PTEID_Certificates::getCertFromCard (unsigned long ulIndex)
| For internal use : This method must access protected constructor.
PTEID_Certificate & | PTEID_Certificates::getCert (PTEID_CertifType type)
| For internal use : This method must access protected constructor.
PTEID_Certificate & | PTEID_Crl::getIssuer ()
| For internal use : This method must access protected constructor.
PTEID_Certificate & | PTEID_Certificates::addCertificate (PTEID_ByteArray &cert)
| For internal use : This method must access protected constructor.

## Detailed Description

Class that represent one certificate.

## Constructor & Destructor Documentation

virtual PTEIDSDK_API eIDMW::PTEID_Certificate::~PTEID_Certificate | ( |  | ) | `[virtual]`

Destructor.

## Member Function Documentation

PTEIDSDK_API unsigned long eIDMW::PTEID_Certificate::countChildren | ( |  | ) |

Return the number of children for this certificate.

PTEIDSDK_API const PTEID_ByteArray& eIDMW::PTEID_Certificate::getCertData | ( |  | ) |

Return the content of the certificate.

PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_Certificate::getChildren | ( | unsigned long | ulIndex | ) |

Return the children certificate (certificate that has been issued by this one).

Parameters:

  | ulIndex | is the children index (the index for the first child is 0) Throw PTEID_ExParamRange exception if the index is out of range

PTEIDSDK_API PTEID_Crl& eIDMW::PTEID_Certificate::getCRL | ( |  | ) |

Return the crl of the certificate.

PTEIDSDK_API void eIDMW::PTEID_Certificate::getFormattedData | ( | PTEID_ByteArray & | data | ) |

Return the content of the certificate without ending zero.

PTEIDSDK_API unsigned long eIDMW::PTEID_Certificate::getID | ( |  | ) |

Return the id of the certificate.

PTEIDSDK_API PTEID_Certificate& eIDMW::PTEID_Certificate::getIssuer | ( |  | ) |

Return the issuer certificate.

if there is no issuer (root), PTEID_ExCertNoIssuer exception is thrown

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getIssuerName | ( |  | ) |

Return the name of the issuer of the certificate.

PTEIDSDK_API unsigned long eIDMW::PTEID_Certificate::getKeyLength | ( |  | ) |

Return the length of public/private key on the certificate.

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getLabel | ( |  | ) |

Return the label of the certificate.

PTEIDSDK_API PTEID_OcspResponse& eIDMW::PTEID_Certificate::getOcspResponse | ( |  | ) |

Return the ocsp response object of the certificate.

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getOwnerName | ( |  | ) |

Return the name of the owner of the certificate.

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getSerialNumber | ( |  | ) |

Return the serial number of the certificate.

PTEIDSDK_API PTEID_CertifStatus eIDMW::PTEID_Certificate::getStatus | ( | PTEID_ValidationLevel | crl,
|  | PTEID_ValidationLevel | ocsp |
| ) |  |  |

Return the status of the certificate.

PTEIDSDK_API PTEID_CertifStatus eIDMW::PTEID_Certificate::getStatus | ( |  | ) |

Return the status of the certificate using default validation level (from config).

PTEIDSDK_API PTEID_CertifType eIDMW::PTEID_Certificate::getType | ( |  | ) |

Return the type of the certificate.

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getValidityBegin | ( |  | ) |

Return the validity begin date of the certificate.

PTEIDSDK_API const char* eIDMW::PTEID_Certificate::getValidityEnd | ( |  | ) |

Return the validity end date of the certificate.

PTEIDSDK_API bool eIDMW::PTEID_Certificate::isFromPteidValidChain | ( |  | ) |

Return true if the certificate chain end by the one of pteid root.

PTEIDSDK_API bool eIDMW::PTEID_Certificate::isFromCard | ( |  | ) |

This certificate comes from the card.

PTEIDSDK_API bool eIDMW::PTEID_Certificate::isRoot | ( |  | ) |

Return true if this is a root certificate.

PTEIDSDK_API bool eIDMW::PTEID_Certificate::isTest | ( |  | ) |

Return the test status.

Returns:
  true if test certificate

  false if good one

PTEIDSDK_API PTEID_CertifStatus eIDMW::PTEID_Certificate::verifyCRL | ( | bool | forceDownload = `false` | ) |

Verify the certificate trough CRL validation.

PTEIDSDK_API PTEID_CertifStatus eIDMW::PTEID_Certificate::verifyOCSP | ( |  | ) |

Verify the certificate trough OCSP validation.

## Friends And Related Function Documentation

PTEID_Certificate& PTEID_Certificates::addCertificate | ( | PTEID_ByteArray & | cert | ) | `[friend]`

For internal use : This method must access protected constructor.

PTEID_Certificate& PTEID_Certificates::getCert | ( | PTEID_CertifType | type | ) | `[friend]`

For internal use : This method must access protected constructor.

PTEID_Certificate& PTEID_Certificates::getCert | ( | unsigned long | ulIndex | ) | `[friend]`

For internal use : This method must access protected constructor.

PTEID_Certificate& PTEID_Certificates::getCertFromCard | ( | unsigned long | ulIndex | ) | `[friend]`

For internal use : This method must access protected constructor.

PTEID_Certificate& PTEID_Crl::getIssuer | ( |  | ) | `[friend]`

For internal use : This method must access protected constructor.

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

- eidlib.h