TElCertificateRequest.SaveKeyToBufferPEM method

TElCertificateRequest.SaveKeyToBufferPEM

Saves the private key of the Certificate Request to the memory buffer in PEM format.

Declaration

[C#]
    bool SaveKeyToBufferPEM(out byte[] Buffer, string Passphrase);
    bool SaveKeyToBufferPEM(out byte[] Buffer, int EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode, string Passphrase);
    bool SaveKeyToBufferPEM(ref byte[] Buffer, ref int Size, string Passphrase);
    bool SaveKeyToBufferPEM(ref byte[] Buffer, int EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode, ref int Size, string Passphrase);

[VB.NET]
    Function SaveKeyToBufferPEM(Out Buffer As Byte(), ByVal Passphrase As String) As Boolean
    Function SaveKeyToBufferPEM(Out Buffer As Byte(), ByVal EncryptionAlgorithm As Integer, ByVal EncryptionMode As TSBSymmetricCryptoMode, ByVal Passphrase As String) As Boolean
    Function SaveKeyToBufferPEM(ByRef Buffer As Byte(), ByRef Size As Integer, ByVal Passphrase As String) As Boolean
    Function SaveKeyToBufferPEM(ByRef Buffer As Byte(), ByVal EncryptionAlgorithm As Integer, ByVal EncryptionMode As TSBSymmetricCryptoMode, ByRef Size As Integer, ByVal Passphrase As String) As Boolean

[Pascal]
function SaveKeyToBufferPEM(Buffer: pointer; var Size: integer; const Passphrase: string) : boolean;

[C++]
bool SaveKeyToBufferPEM(void * Buffer, int32_t &Size, const std::string &Passphrase);
bool SaveKeyToBufferPEM(void * Buffer, int32_t EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode, int32_t &Size, const std::string &Passphrase);

[Java]
    boolean saveKeyToBufferPEM(byte[][] Buffer, String Passphrase);
    boolean saveKeyToBufferPEM(byte[][] Buffer, int EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode, String Passphrase);
    boolean saveKeyToBufferPEM(byte[] Buffer, TSBInteger Size, String Passphrase);
    boolean saveKeyToBufferPEM(byte[] Buffer, int EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode, TSBInteger Size, String Passphrase);

Parameters

Buffer - the buffer to which the private key is saved.
Size - the size of the buffer to which the private key is saved. When the method returns, Size parameter contains the size of the data that were saved, or, if the buffer was too small, the size of the buffer enough to hold the data.
PassPhrase - the pass phrase to encrypt the private key. If the key shouldn't be encrypted, set this parameter to empty string
EncryptionAlgorithm - ...
EncryptionMode - ...

TSBSymmetricCryptoMode values

[.NET]	[Pascal]	[C++]	Description
cmDefault = 0	cmDefault	_cmDefault = 0	Default encryption mode for block ciphers. Currently CBC is default mode. For stream ciphers Default is the only mode
cmECB = 1	cmECB	_cmECB = 1	ECB encryption mode
cmCBC = 2	cmCBC	_cmCBC = 2	CBC encryption mode
cmCTR = 3	cmCTR	_cmCTR = 3	CTR encryption mode
cmCFB8 = 4	cmCFB8	_cmCFB8 = 4	CFB8 encryption mode
cmGCM = 5	cmGCM	_cmGCM = 5	GCM encryption mode
cmCCM = 6	cmCCM	_cmCCM = 6	CCM encryption mode

Return value

True on success.
False if the buffer size is too small. In this case this method sets Size parameter to the size which will be enough to hold the whole data.

Description

This method saves the private key to the provided memory location of the given size. If the buffer is too small (or empty), Size parameter is set to the size which will be enough to hold the whole data. The private key is saved in PEM format.

Discuss this help topic in SecureBlackbox Forum