Certificate for SSL.

Inheritance:

Public Methods

	PSSLCertificate () Create an empty certificate
	PSSLCertificate ( const PFilePath & certFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Create a new certificate given the file.
	PSSLCertificate ( const BYTE* certData, PINDEX certSize ) Create certificate from the binary ASN1 DER encoded data specified.
	PSSLCertificate ( const PBYTEArray & certData ) Create certificate from the binary ASN1 DER encoded data specified.
	PSSLCertificate ( const PString & certString ) Create certificate from the ASN1 DER base64 encoded data specified.
	PSSLCertificate ( const PSSLCertificate & cert ) Create a copy of the certificate
PSSLCertificate&	operator= ( const PSSLCertificate & cert ) Create a copy of the certificate
	~PSSLCertificate () Destroy and release storage for certificate
	operator x509_st * () const Get internal OpenSSL X509 structure
BOOL	CreateRoot ( const PString & subject, const PSSLPrivateKey & key ) Create a new root certificate.
PBYTEArray	GetData () const Get the certificate as binary ASN1 DER encoded data
PString	AsString () const Get the certificate as ASN1 DER base64 encoded data
BOOL	Load ( const PFilePath & certFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Load certificate from file.
BOOL	Save ( const PFilePath & keyFile, BOOL append = FALSE, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Save certificate to file.

Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Public Members

Comparison functions

Documentation

Certificate for SSL. This class embodies a common environment for all certificates used by the PSSLContext and PSSLChannel classes.

PSSLCertificate()

Create an empty certificate

PSSLCertificate( const PFilePath & certFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT )

Create a new certificate given the file. The type of the certificate key can be specified explicitly, or if PSSLFileTypeDEFAULT it will be determined from the file extension, ".pem" is a text file, anything else eg ".der" is a binary ASN1 file.

Parameters:

certFile - Certificate file
fileType - Type of file to read

PSSLCertificate( const BYTE* certData, PINDEX certSize )

Create certificate from the binary ASN1 DER encoded data specified.

Parameters:

certData - Certificate data
certSize - Size of certificate data

PSSLCertificate( const PBYTEArray & certData )

Create certificate from the binary ASN1 DER encoded data specified.

Parameters:

certData - Certificate data

PSSLCertificate( const PString & certString )

Create certificate from the ASN1 DER base64 encoded data specified.

Parameters:

certString - Certificate data as string

PSSLCertificate( const PSSLCertificate & cert )

Create a copy of the certificate

PSSLCertificate& operator=( const PSSLCertificate & cert )

Create a copy of the certificate

~PSSLCertificate()

Destroy and release storage for certificate

operator x509_st *() const

Get internal OpenSSL X509 structure

BOOL CreateRoot( const PString & subject, const PSSLPrivateKey & key )

Create a new root certificate. The subject name is a string of the form "/name=value/name=value" where name is a short name for the field and value is a string value for the field for example: "/C=ZA/SP=Western Cape/L=Cape Town/O=Thawte Consulting cc" "/OU=Certification Services Division/CN=Thawte Server CA" "/Email=server-certs@thawte.com"

Parameters:

- subject Subject name for certificate
- key Key to sign certificate with

PBYTEArray GetData() const

Get the certificate as binary ASN1 DER encoded data

PString AsString() const

Get the certificate as ASN1 DER base64 encoded data

BOOL Load( const PFilePath & certFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT )

Load certificate from file. The type of the certificate key can be specified explicitly, or if PSSLFileTypeDEFAULT it will be determined from the file extension, ".pem" is a text file, anything else eg ".der" is a binary ASN1 file.

Parameters:

certFile - Certificate file
fileType - Type of file to read

BOOL Save( const PFilePath & keyFile, BOOL append = FALSE, PSSLFileTypes fileType = PSSLFileTypeDEFAULT )

Save certificate to file. The type of the certificate key can be specified explicitly, or if PSSLFileTypeDEFAULT it will be determined from the file extension, ".pem" is a text file, anything else eg ".der" is a binary ASN1 file.

Parameters:

keyFile - Certificate key file
append - Append to file
fileType - Type of file to write

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java