Private key for SSL.

Inheritance:

Public Methods

	PSSLPrivateKey () Create an empty private key
	PSSLPrivateKey ( unsigned modulus, void (*callback)(int, int, void* ) = NULL, Progress callback function void* cb_arg = NULL ) Create a new RSA private key.
	PSSLPrivateKey ( const PFilePath & keyFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Create a new private key given the file.
	PSSLPrivateKey ( const BYTE* keyData, PINDEX keySize ) Create private key from the binary ASN1 DER encoded data specified.
	PSSLPrivateKey ( const PBYTEArray & keyData ) Create private key from the binary ASN1 DER encoded data specified.
	PSSLPrivateKey ( const PSSLPrivateKey & privKey ) Create a copy of the private key
PSSLPrivateKey&	operator= ( const PSSLPrivateKey & privKay ) Create a copy of the private key
	~PSSLPrivateKey () Destroy and release storage for private key
	operator evp_pkey_st * () const Get internal OpenSSL private key structure
BOOL	Create ( unsigned modulus, void (*callback)(int, int, void* ) = NULL, Progress callback function void* cb_arg = NULL ) Create a new private key.
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 & keyFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Load private key from file.
BOOL	Save ( const PFilePath & keyFile, BOOL append = FALSE, PSSLFileTypes fileType = PSSLFileTypeDEFAULT ) Save private key to file.

Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Public Members

Comparison functions

Documentation

Private key for SSL. This class embodies a common environment for all private keys used by the PSSLContext and PSSLChannel classes.

PSSLPrivateKey()

Create an empty private key

PSSLPrivateKey( unsigned modulus, void (*callback)(int, int, void* ) = NULL, Progress callback function void* cb_arg = NULL )

Create a new RSA private key.

Parameters:

modulus - Number of bits
cb_arg - Argument passed to callback

PSSLPrivateKey( const PFilePath & keyFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT )

Create a new private key given the file. The type of the private 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 - Private key file
fileType - Type of file to read

PSSLPrivateKey( const BYTE* keyData, PINDEX keySize )

Create private key from the binary ASN1 DER encoded data specified.

Parameters:

keyData - Private key data
keySize - Size of private key data

PSSLPrivateKey( const PBYTEArray & keyData )

Create private key from the binary ASN1 DER encoded data specified.

Parameters:

keyData - Private key data

PSSLPrivateKey( const PSSLPrivateKey & privKey )

Create a copy of the private key

PSSLPrivateKey& operator=( const PSSLPrivateKey & privKay )

Create a copy of the private key

~PSSLPrivateKey()

Destroy and release storage for private key

operator evp_pkey_st *() const

Get internal OpenSSL private key structure

BOOL Create( unsigned modulus, void (*callback)(int, int, void* ) = NULL, Progress callback function void* cb_arg = NULL )

Create a new private key.

Parameters:

modulus - Number of bits
cb_arg - Argument passed to callback

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 & keyFile, PSSLFileTypes fileType = PSSLFileTypeDEFAULT )

Load private key from file. The type of the private 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 - Private key file
fileType - Type of file to read

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

Save private key to file. The type of the private 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 - Private 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