Back to product page

PrivateKey property


Private key for authentication.

Type

Byte[] array.

Syntax

  • C#
  • VB.NET
Byte[] PrivateKey {get; set; };

Property PrivateKey As Byte[]

Remarks

PrivateKey property sets and returns byte array that represents private key that will be used with authentication. You can get reference to private key either from our KeyManager component, or by loading it directly from disk where it should be saved in raw format. You must setup Authentication property prior to authenticating with your key. During connection stage, if wodSFTP.NET requires private key to authenticate to the server, it will look in this property and pass public key derived from it to the server. If both keys matches, you will be able to connect just by specifying private key, without any passwords.

You should use our KeyManager component to load keys from the disk, and pass them here as a byte array. Or, you can just load it from the disk, convert to byte array, and pass to PrivateKey property. When loaded from the disk using your own method, it should be loaded from raw pool, as provided by KeyManager.PrivateKey property.

Platforms

Windows