Website Download Support
 

Discuss this help topic in SecureBlackbox Forum

TElCustomCertStorage.SaveToBufferPEM

TElCustomCertStorage     See also     

Filter: C#  VB.NET  Pascal  C++  PHP  Java  

Saves the certificates to the memory buffer in PEM format.

Declaration

[C#]
    bool SaveToBufferPEM(ref byte[] Buffer, ref int Size, string Password);
    bool SaveToBufferPEM(ref byte[] Buffer, ref int Size, string Password, int EncryptionAlgorithm, TSBSymmetricCryptoMode EncryptionMode);

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

[Pascal]
    function SaveToBufferPEM(Buffer : pointer; var Size : longint; const Password : string) : boolean;
    function SaveToBufferPEM(Buffer : pointer; var Size : longint; const Password : string; EncryptionAlgorithm : integer; EncryptionMode : TSBSymmetricCryptoMode) : boolean;

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

[PHP]
    bool SaveToBufferPEM(TSBPointer|array of byte|string|NULL $Buffer, integer &$Size, string $Password)
    bool SaveToBufferPEM(TSBPointer|array of byte|string|NULL $Buffer, integer &$Size, string $Password, integer $EncryptionAlgorithm, integer $EncryptionMode)

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

Parameters

  • Buffer - the buffer where the certificates are saved.
  • Size - the size of the buffer where the data is saved. On return, this parameter contains the size of the data that were saved, or the size of the required buffer if the buffer was too small to hold the data.
  • Password - the password to encrypt the certificates. If the data shouldn't be encrypted, provide an empty string.
  • EncryptionAlgorithm - specifies the encryption algorithm.
  • EncryptionMode - specifies the encryption mode.

Possible modes:

[.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

Possible algorithms:

Definition Value Description
SB_ALGORITHM_CNT_RC4 0x7001 Specifies RC4 algorithm
SB_ALGORITHM_CNT_DES 0x7002 Specifies DES algorithm
SB_ALGORITHM_CNT_3DES 0x7003 Specifies 3DES algorithm
SB_ALGORITHM_CNT_RC2 0x7004 Specifies RC2 algorithm
SB_ALGORITHM_CNT_AES128 0x7005 Specifies AES algorithm with a 128-bit key
SB_ALGORITHM_CNT_AES192 0x7006 Specifies AES algorithm with a 192-bit key
SB_ALGORITHM_CNT_AES256 0x7007 Specifies AES algorithm with a 256-bit key
SB_ALGORITHM_CNT_IDENTITY 0x700A Specifies NO encryption. The data is returned as original.
SB_ALGORITHM_CNT_BLOWFISH 0x7010 Specifies Blowfish algorithm
SB_ALGORITHM_CNT_TWOFISH 0x7011 Specifies Twofish algorithm
SB_ALGORITHM_CNT_CAMELLIA 0x7012 Specifies Camellia algorithm
SB_ALGORITHM_CNT_CAST128 0x7013 Specifies CAST algorithm
SB_ALGORITHM_CNT_IDEA 0x7014 Specifies IDEA algorithm
SB_ALGORITHM_CNT_SERPENT 0x7015 Specifies Serpent algorithm
SB_ALGORITHM_CNT_TWOFISH128 0x7016 Specifies Twofish algorithm with a 128-bit key
SB_ALGORITHM_CNT_TWOFISH192 0x7017 Specifies Twofish algorithm with a 192-bit key
SB_ALGORITHM_CNT_TWOFISH256 0x7018 Specifies Twofish algorithm with a 256-bit key
SB_ALGORITHM_CNT_CAMELLIA128 0x7019 Specifies Camellia algorithm with a 128-bit key
SB_ALGORITHM_CNT_CAMELLIA192 0x701A Specifies Camellia algorithm with a 192-bit key
SB_ALGORITHM_CNT_CAMELLIA256 0x701B Specifies Camellia algorithm with a 256-bit key
SB_ALGORITHM_CNT_SERPENT128 0x701C Specifies Serpent algorithm with a 128-bit key
SB_ALGORITHM_CNT_SERPENT192 0x701D Specifies Serpent algorithm with a 192-bit key
SB_ALGORITHM_CNT_SERPENT256 0x701E Specifies Serpent algorithm with a 256-bit key
SB_ALGORITHM_CNT_SEED 0x7020 Specifies SEED algorithm
SB_ALGORITHM_CNT_RABBIT 0x7021 Specifies Rabbit algorithm
SB_ALGORITHM_CNT_SYMMETRIC 0x7022 A general value for a symmetric algorithm
SB_ALGORITHM_CNT_GOST_28147_1989 0x7023 GOST 28147-89 algorithm
SB_ALGORITHM_AEAD_CHACHA20_POLY1305 0x7501 ChaCha20-Poly1305
SB_ALGORITHM_AEAD_AES128_GCM 0x7502 AEAD_AES_128_GCM algorithm as defined in RFC 5116
SB_ALGORITHM_AEAD_AES192_GCM 0x7503 AEAD_AES_192_GCM
SB_ALGORITHM_AEAD_AES256_GCM 0x7504 AEAD_AES256_GCM algorithm as defined in RFC 5116
SB_ALGORITHM_AEAD_AES128_CCM 0x7505 AEAD_AES128_CCM algorithm as defined in RFC 5116
SB_ALGORITHM_AEAD_AES192_CCM 0x7506 AEAD_AES192_CCM
SB_ALGORITHM_AEAD_AES256_CCM 0x7507 AEAD_AES256_CCM algorithm as defined in RFC 5116

Return value

    Returns True on success, and False if the buffer was too small for the data. In this case, check the Size parameter for the required buffer size.

Description

    Use this method to save the certificates to the memory buffer in PEM format.

See also:     LoadFromStreamPEM     LoadFromBufferPEM     SaveToStreamPEM    

Discuss this help topic in SecureBlackbox Forum

Copyright (c) 2018, /n software, inc.