class PSSLPrivateKey

Private key for SSL.

Inheritance:


Public Methods

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

o 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

o 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

o 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

o PSSLPrivateKey( const PBYTEArray & keyData )
Create private key from the binary ASN1 DER encoded data specified.
Parameters:
keyData - Private key data

o PSSLPrivateKey( const PSSLPrivateKey & privKey )
Create a copy of the private key

oPSSLPrivateKey& operator=( const PSSLPrivateKey & privKay )
Create a copy of the private key

o ~PSSLPrivateKey()
Destroy and release storage for private key

o operator evp_pkey_st *() const
Get internal OpenSSL private key structure

oBOOL 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

oPBYTEArray GetData() const
Get the certificate as binary ASN1 DER encoded data

oPString AsString() const
Get the certificate as ASN1 DER base64 encoded data

oBOOL 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

oBOOL 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



This page was generated with the help of DOC++.