Discuss this help topic in SecureBlackbox Forum

TElX509Certificate.LoadKeyFromStreamNET

TElX509Certificate     See also     


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


Reads the certificate's private key from the stream. The key should be contained in NET format.

Declaration

[C#]
    int LoadKeyFromStreamNET(System.IO.Stream Stream, string Password, int Count);

[VB.NET]
    Function LoadKeyFromStreamNET(ByVal Stream As System.IO.Stream, ByVal Password As String, ByVal Count As Integer) As Integer

[Pascal]
    function LoadKeyFromStreamNET(Stream : TStream; const Password : string; Count : integer = 0) : integer;

[C++]
    int32_t LoadKeyFromStreamNET(TStream &Stream, const std::string &Password, int32_t Count);
    int32_t LoadKeyFromStreamNET(TStream *Stream, const std::string &Password, int32_t Count);

[PHP]
    integer LoadKeyFromStreamNET(TStream $Stream, string $Password, integer $Count)

[Java]
    int loadKeyFromStreamNET(TElStream Stream, String Password, int Count);
    int loadKeyFromStreamNET(InputStream Stream, String Password, int Count);

Parameters

  • Stream - The stream from which the private key is loaded.
  • Count - Optional parameter that specified the number of bytes to be read. If this parameter is zero, the whole stream (from current position till the end) is read.
  • Password - The password to decrypt the private key. If the key is not encrypted, set this parameter to empty string

Return value

    0 on success.
    PKCS#8 error code otherwise.

Description

    Use this method to read the certificate's private key from the stream. The read operation is started at current stream position and finished when the end of the stream reached or when the number of bytes specified in Count parameter is read. The private key must have been saved in NET format.

    NET format was invented by Microsoft Corp. and is based on PKCS#8 private key format. However, it is not fully compatible with PKCS#8, so passing a buffer with raw PKCS#8 data will cause an 'invalid format' error.

Discuss this help topic in SecureBlackbox Forum