PSSLPrivateKey Class Reference
#include <pssl.h>
List of all members.
|
Public Member Functions |
| PSSLPrivateKey () |
| PSSLPrivateKey (unsigned modulus, void(*callback)(int, int, void *)=NULL, void *cb_arg=NULL) |
| PSSLPrivateKey (const PFilePath &keyFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT) |
| PSSLPrivateKey (const BYTE *keyData, PINDEX keySize) |
| PSSLPrivateKey (const PBYTEArray &keyData) |
| PSSLPrivateKey (const PSSLPrivateKey &privKey) |
PSSLPrivateKey & | operator= (const PSSLPrivateKey &privKay) |
| ~PSSLPrivateKey () |
| operator evp_pkey_st * () const |
PBoolean | Create (unsigned modulus, void(*callback)(int, int, void *)=NULL, void *cb_arg=NULL) |
PBYTEArray | GetData () const |
PString | AsString () const |
PBoolean | Load (const PFilePath &keyFile, PSSLFileTypes fileType=PSSLFileTypeDEFAULT) |
PBoolean | Save (const PFilePath &keyFile, PBoolean append=PFalse, PSSLFileTypes fileType=PSSLFileTypeDEFAULT) |
Protected Attributes |
evp_pkey_st * | key |
Detailed Description
Private key for SSL. This class embodies a common environment for all private keys used by the
PSSLContext and
PSSLChannel classes.
Constructor & Destructor Documentation
PSSLPrivateKey::PSSLPrivateKey |
( |
|
) |
|
Create an empty private key.
PSSLPrivateKey::PSSLPrivateKey |
( |
unsigned |
modulus, |
|
|
void(*)(int, int, void *) |
callback = NULL , |
|
|
void * |
cb_arg = NULL | |
|
) |
| | |
Create a new RSA private key.
- Parameters:
-
modulus |
Number of bits |
callback |
Progress callback function |
cb_arg |
Argument passed to callback |
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::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::PSSLPrivateKey |
( |
const PBYTEArray & |
keyData |
) |
|
Create private key from the binary ASN1 DER encoded data specified.
- Parameters:
-
Create a copy of the private key.
PSSLPrivateKey::~PSSLPrivateKey |
( |
|
) |
|
Destroy and release storage for private key.
Member Function Documentation
Create a copy of the private key.
PSSLPrivateKey::operator evp_pkey_st * |
( |
|
) |
const [inline] |
Get internal OpenSSL private key structure.
References key.
PBoolean PSSLPrivateKey::Create |
( |
unsigned |
modulus, |
|
|
void(*)(int, int, void *) |
callback = NULL , |
|
|
void * |
cb_arg = NULL | |
|
) |
| | |
Create a new private key.
- Parameters:
-
modulus |
Number of bits |
callback |
Progress callback function |
cb_arg |
Argument passed to callback |
Get the certificate as binary ASN1 DER encoded data.
PString PSSLPrivateKey::AsString |
( |
|
) |
const |
Get the certificate as ASN1 DER base64 encoded data.
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 |
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 |
Member Data Documentation
The documentation for this class was generated from the following file: