Main Page | Class Hierarchy | Class List | File List | Class Members | File Members

PSSLCertificate Class Reference

#include <pssl.h>

Inheritance diagram for PSSLCertificate:

PObject List of all members.

Public Member Functions

 PSSLCertificate ()
 PSSLCertificate (const PFilePath &certFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT)
 PSSLCertificate (const BYTE *certData, PINDEX certSize)
 PSSLCertificate (const PBYTEArray &certData)
 PSSLCertificate (const PString &certString)
 PSSLCertificate (const PSSLCertificate &cert)
PSSLCertificateoperator= (const PSSLCertificate &cert)
 ~PSSLCertificate ()
 operator x509_st * () const
BOOL CreateRoot (const PString &subject, const PSSLPrivateKey &key)
PBYTEArray GetData () const
PString AsString () const
BOOL Load (const PFilePath &certFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT)
BOOL Save (const PFilePath &keyFile, BOOL append=FALSE, PSSLFileTypes fileType=PSSLFileTypeDEFAULT)

Protected Attributes

x509_st * certificate

Detailed Description

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


Constructor & Destructor Documentation

PSSLCertificate::PSSLCertificate  ) 
 

Create an empty certificate.

PSSLCertificate::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:
fileType  Certificate file Type of file to read

PSSLCertificate::PSSLCertificate const BYTE *  certData,
PINDEX  certSize
 

Create certificate from the binary ASN1 DER encoded data specified.

Parameters:
certSize  Certificate data Size of certificate data

PSSLCertificate::PSSLCertificate const PBYTEArray certData  ) 
 

Create certificate from the binary ASN1 DER encoded data specified.

Parameters:
certData  Certificate data

PSSLCertificate::PSSLCertificate const PString certString  ) 
 

Create certificate from the ASN1 DER base64 encoded data specified.

Parameters:
certString  Certificate data as string

PSSLCertificate::PSSLCertificate const PSSLCertificate cert  ) 
 

Create a copy of the certificate.

PSSLCertificate::~PSSLCertificate  ) 
 

Destroy and release storage for certificate.


Member Function Documentation

PString PSSLCertificate::AsString  )  const
 

Get the certificate as ASN1 DER base64 encoded data.

BOOL PSSLCertificate::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:
key  Subject name for certificate Key to sign certificate with

PBYTEArray PSSLCertificate::GetData  )  const
 

Get the certificate as binary ASN1 DER encoded data.

BOOL PSSLCertificate::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:
fileType  Certificate file Type of file to read

PSSLCertificate::operator x509_st *  )  const [inline]
 

Get internal OpenSSL X509 structure.

PSSLCertificate& PSSLCertificate::operator= const PSSLCertificate cert  ) 
 

Create a copy of the certificate.

BOOL PSSLCertificate::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:
append  Certificate key file
fileType  Append to file Type of file to write


Member Data Documentation

x509_st* PSSLCertificate::certificate [protected]
 


The documentation for this class was generated from the following file:
Generated on Sat Jul 24 15:36:00 2004 for PWLib by doxygen 1.3.7