TElSSHKey.LoadPrivateKey method

TElSSHKey.LoadPrivateKey

This method loads the private key from file or buffer.

Declaration

[C#]
int LoadPrivateKey(string PrivateKeyFile, string Passphrase);
int LoadPrivateKey(byte[] Buffer, int Size, string Passphrase);

[VB.NET]
Function LoadPrivateKey(ByVal PrivateKeyFile As String, ByVal Passphrase As String) As Integer
Function LoadPrivateKey(ByVal Buffer As Byte(), ByVal Size As Integer, ByVal Passphrase As String) As Integer

[Pascal]
function LoadPrivateKey(const PrivateKeyFile : string; const Passphrase : string = '') : integer;
function LoadPrivateKey(Buffer : pointer; Size : integer; const Passphrase : string = '') : integer;

[C++]
int32_t LoadPrivateKey(const std::string &PrivateKeyFile, const std::string &Passphrase);
int32_t LoadPrivateKey(void * Buffer, int32_t Size, const std::string &Passphrase);

[PHP]
integer LoadPrivateKey(string $PrivateKeyFile, string $Passphrase)
integer LoadPrivateKey(TSBPointer|array of byte|string|NULL $Buffer, integer $Size, string $Passphrase)

[Java]
int loadPrivateKey(byte[] Buffer, int Size, String Passphrase);
int loadPrivateKey(String PrivateKeyFile, String Passphrase);

Parameters

PrivateKeyFile - file which contains private key
Passphrase - password of the file with private key
Buffer - buffer which contains private key
Size - size of the buffer from which the data is loaded

Return value

Returns 0 on success, and error code otherwise.

Error codes

Definition	Value	Description
SB_ERROR_SSH_KEYS_INVALID_PUBLIC_KEY	3329 (0x0D01)	Public key is invalid
SB_ERROR_SSH_KEYS_INVALID_PRIVATE_KEY	3330 (0x0D02)	Private key is invalid
SB_ERROR_SSH_KEYS_FILE_READ_ERROR	3331 (0x0D03)	Error of reading from file
SB_ERROR_SSH_KEYS_FILE_WRITE_ERROR	3332 (0x0D04)	Error of writing to file
SB_ERROR_SSH_KEYS_UNSUPPORTED_ALGORITHM	3333 (0x0D05)	Algorithm is unsupported
SB_ERROR_SSH_KEYS_INTERNAL_ERROR	3334 (0x0D06)	Internal error
SB_ERROR_SSH_KEYS_BUFFER_TOO_SMALL	3335 (0x0D07)	Buffer is too small
SB_ERROR_SSH_KEYS_NO_PRIVATE_KEY	3336 (0x0D08)	There is no private key
SB_ERROR_SSH_KEYS_INVALID_PASSPHRASE	3337 (0x0D09)	Wrong password for private key
SB_ERROR_SSH_KEYS_UNSUPPORTED_PEM_ALGORITHM	3338 (0x0D0A)	PEM algorithm is unsupported

Description

Use this method to load RSA/DSA private key from file or buffer.
If the key is stored in Putty format (the file contains both public and private keys; only the private key is protected), and SB_ERROR_SSH_KEYS_INVALID_PASSPHRASE is returned, the public part of the key will be loaded anyway.

Discuss this help topic in SecureBlackbox Forum