IceSSL::OpenSSL::Certificate Class Reference

Encapsulates an OpenSSL X.509 certificate. More...

#include <IceSSL/IceSSL.h>

Inheritance diagram for IceSSL::OpenSSL::Certificate:

Collaboration diagram for IceSSL::OpenSSL::Certificate:

Public Member Functions
virtual x509_st *	getCert () const =0
	Retrieve the native X509 certificate value wrapped by this object.
Public Member Functions inherited from IceSSL::Certificate
virtual bool	checkValidity () const =0
	Checks that the certificate is currently valid, that is, the current date falls between the validity period given in the certificate.
virtual bool	checkValidity (const std::chrono::system_clock::time_point &t) const =0
	Checks that the certificate is valid at the given time.
virtual std::string	encode () const =0
	Obtains a string encoding of the certificate in PEM format.
virtual std::vector< Ice::Byte >	getAuthorityKeyIdentifier () const =0
	Obtains the authority key identifier.
unsigned int	getExtendedKeyUsage () const
	Returns the value of the extended key usage extension.
virtual std::vector< std::pair< int, std::string > >	getIssuerAlternativeNames () const =0
	Obtains the values in the issuer's alternative names extension.
virtual DistinguishedName	getIssuerDN () const =0
	Obtains the issuer's distinguished name (DN).
unsigned int	getKeyUsage () const
	Returns the value of the key usage extension.
virtual std::chrono::system_clock::time_point	getNotAfter () const =0
	Obtains the not-after validity time.
virtual std::chrono::system_clock::time_point	getNotBefore () const =0
	Obtains the not-before validity time.
virtual std::string	getSerialNumber () const =0
	Obtains the serial number.
virtual std::vector< std::pair< int, std::string > >	getSubjectAlternativeNames () const =0
	See the comment for Plugin::getIssuerAlternativeNames.
virtual DistinguishedName	getSubjectDN () const =0
	Obtains the subject's distinguished name (DN).
virtual std::vector< Ice::Byte >	getSubjectKeyIdentifier () const =0
	Obtains the subject key identifier.
virtual int	getVersion () const =0
	Obtains the certificate version number.
virtual X509ExtensionPtr	getX509Extension (const std::string &oid) const =0
	Obtains the extension with the given OID.
virtual std::vector< X509ExtensionPtr >	getX509Extensions () const =0
	Obtains a list of the X509v3 extensions contained in the certificate.
virtual bool	operator!= (const Certificate &) const =0
	Compares the certificates for equality using the native certificate comparison method.
virtual bool	operator== (const Certificate &) const =0
	Compares the certificates for equality using the native certificate comparison method.
virtual std::string	toString () const =0
	Stringifies the certificate.
virtual bool	verify (const CertificatePtr &cert) const =0
	Verifies that this certificate was signed by the given certificate public key.

Static Public Member Functions
static CertificatePtr	create (x509_st *cert)
	Construct a certificate using a native certificate.
static CertificatePtr	decode (const std::string &cert)
	Decode a certificate from a string that uses the PEM encoding format.
static CertificatePtr	load (const std::string &file)
	Load the certificate from a file.
Static Public Member Functions inherited from IceSSL::Certificate
static CertificatePtr	decode (const std::string &str)
	Decodes a certificate from a string that uses the PEM encoding format.
static CertificatePtr	load (const std::string &file)
	Loads the certificate from a file.

Detailed Description

Encapsulates an OpenSSL X.509 certificate.

Member Function Documentation

create()

CertificatePtr IceSSL::OpenSSL::Certificate::create ( x509_st * cert )

static

Construct a certificate using a native certificate.

The Certificate class assumes ownership of the given native certificate.

Parameters

cert	The native certificate.

Returns

A new certificate object.

decode()

CertificatePtr IceSSL::OpenSSL::Certificate::decode ( const std::string & cert )

static

Decode a certificate from a string that uses the PEM encoding format.

Parameters

cert	A string containing the PEM-encoded certificate.

Returns

A new certificate object.

Exceptions

CertificateEncodingException

if an error occurs.

getCert()

virtual x509_st * IceSSL::OpenSSL::Certificate::getCert ( ) const

pure virtual

Retrieve the native X509 certificate value wrapped by this object.

Returns

The native certificate. The returned reference is only valid for the lifetime of this object. You can increment it with X509_dup.

load()

CertificatePtr IceSSL::OpenSSL::Certificate::load ( const std::string & file )

static

Load the certificate from a file.

The certificate must use the PEM encoding format.

Parameters

file	The certificate file.

Returns

A new certificate object.

Exceptions

CertificateReadException

if the file cannot be read.

---

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

• IceSSL/OpenSSL.h