SSHKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The SSHKeyManager component stores information about SSH keys.

Syntax

nsoftware.SecureBlackbox.Sshkeymanager

Remarks

SSHKeyManager provides the capabilities of generating, storing, importing, and exporting SSH keys.

Property List

The following is the full list of the properties of the component with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the component with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the component with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the component with short descriptions. Click on the links for further details.

Certificate Property (SSHKeyManager Component)

A container for the certificate object.

Syntax

• C#
• VB.NET

public Certificate Certificate { get; set; }

Public Property Certificate As Certificate

Remarks

Use this property to set or access the properties of the certificate object on which an import or export action is to be performed.

This property is not available at design time.

CryptoKey Property (SSHKeyManager Component)

The key object that the manager is currently working with.

Syntax

• C#
• VB.NET

public CryptoKey CryptoKey { get; set; }

Public Property CryptoKey As CryptoKey

Remarks

Use this property to pass a key to the manager (for example, for importing), or to obtain a key from the manager (e.g., after exporting to it).

This property is not available at design time.

FIPSMode Property (SSHKeyManager Component)

Reserved.

Syntax

• C#
• VB.NET

public bool FIPSMode { get; set; }

Public Property FIPSMode As Boolean

Default Value

False

Remarks

This property is reserved for future use.

Key Property (SSHKeyManager Component)

The key which is currently being processed.

Syntax

• C#
• VB.NET

public SSHKey Key { get; set; }

Public Property Key As SSHKey

Remarks

This property contains the key on which the component could operate now.

This property is not available at design time.

Config Method (SSHKeyManager Component)

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Public Function Config(ByVal ConfigurationString As String) As String

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DoAction Method (SSHKeyManager Component)

Performs an additional action.

Syntax

• C#
• VB.NET

public string DoAction(string actionID, string actionParams);

Public Function DoAction(ByVal ActionID As String, ByVal ActionParams As String) As String

Remarks

DoAction is a generic method available in every component. It is used to perform an additional action introduced after the product major release. The list of actions is not fixed, and may be flexibly extended over time.

The unique identifier (case insensitive) of the action is provided in the ActionID parameter.

ActionParams contains the value of a single parameter, or a list of multiple parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

ExportBytes Method (SSHKeyManager Component)

Writes the key to a memory buffer.

Syntax

• C#
• VB.NET

public byte[] ExportBytes(int keyType, string password);

Public Function ExportBytes(ByVal KeyType As Integer, ByVal Password As String) As Byte()

Remarks

Use this method to save Key in the buffer. KeyType specifies the format in which the key should be stored, and Password is a password to decrypt the private key.

Allowed key types:

ExportToCert Method (SSHKeyManager Component)

Exports the key to a certificate.

Syntax

• C#
• VB.NET

public void ExportToCert();

Public Sub ExportToCert()

Remarks

Use this method to save the Key (both the public and secret parts) to the certificate specified in Certificate.

ExportToCryptoKey Method (SSHKeyManager Component)

Exports the key to a crypto key object.

Syntax

• C#
• VB.NET

public void ExportToCryptoKey();

Public Sub ExportToCryptoKey()

Remarks

Use this method to save the Key (both the public and secret parts) to the crypto key provided via CryptoKey.

ExportToFile Method (SSHKeyManager Component)

Writes key to file.

Syntax

• C#
• VB.NET

public void ExportToFile(int keyType, string path, string password);

Public Sub ExportToFile(ByVal KeyType As Integer, ByVal Path As String, ByVal Password As String)

Remarks

Use this method to save Key in the file. KeyType specifies the format in which the key should be stored, Path specifies the full path to the file, and Password is a password to decrypt the private key.

Allowed key types:

ExportToStream Method (SSHKeyManager Component)

Writes the key to a stream.

Syntax

• C#
• VB.NET

public void ExportToStream(int keyType, System.IO.Stream stream, string password);

Public Sub ExportToStream(ByVal KeyType As Integer, ByVal Stream As System.IO.Stream, ByVal Password As String)

Remarks

Use this method to save Key in the stream specified by Stream. KeyType specifies the format in which the key should be stored, and Password specifies a password to decrypt the private key.

Allowed key types:

Generate Method (SSHKeyManager Component)

Generates a new SSH key.

Syntax

• C#
• VB.NET

public void Generate(string keyAlgorithm, string scheme, string schemeParams, int keyBits);

Public Sub Generate(ByVal KeyAlgorithm As String, ByVal Scheme As String, ByVal SchemeParams As String, ByVal KeyBits As Integer)

Remarks

Call this method to generate a new key or keypair with the desired KeyAlgorithm and KeyBits of length.

The generated key will be populated in the Key property.

The KeyAlgorithm parameter supports the following algorithm identifiers:

• RSA
• DSS
• ECDSA
• EDDSA

If using ECDSA, the following curves are supported (to be passed as the Scheme parameter):

• NISTP256
• NISTP384
• NISTP521
• NISTK163
• NISTP192
• NISTP224
• NISTK233
• NISTB233
• NISTK283
• NISTK409
• NISTB409
• NISTK571

The following curves can also be used with EDDSA:

• CURVE25519
• CURVE448

GetKeyParam Method (SSHKeyManager Component)

Returns an algorithm-specific key parameter.

Syntax

• C#
• VB.NET

public byte[] GetKeyParam(string name);

Public Function GetKeyParam(ByVal Name As String) As Byte()

Remarks

Use this method to retrieve an algorithm-specific key parameter.

GetKeyParamStr Method (SSHKeyManager Component)

Returns an algorithm-specific key parameter to a string.

Syntax

• C#
• VB.NET

public string GetKeyParamStr(string name);

Public Function GetKeyParamStr(ByVal Name As String) As String

Remarks

Use this method to get an algorithm-specific key parameter to a string.

ImportBytes Method (SSHKeyManager Component)

Loads key from buffer.

Syntax

• C#
• VB.NET

public void ImportBytes(byte[] bytes, string password);

Public Sub ImportBytes(ByVal Bytes As Byte(), ByVal Password As String)

Remarks

Use this method to read a key stored in a buffer. Password specifies a password to decrypt the private key.

ImportFromCert Method (SSHKeyManager Component)

Loads a key from a certificate.

Syntax

• C#
• VB.NET

public void ImportFromCert();

Public Sub ImportFromCert()

Remarks

Use this method to load a key, either public or secret, from a certificate.

ImportFromCryptoKey Method (SSHKeyManager Component)

Imports a key from a crypto key.

Syntax

• C#
• VB.NET

public void ImportFromCryptoKey();

Public Sub ImportFromCryptoKey()

Remarks

Use this method to load a key, either public or private, from a crypto key. Provide the key via CryptoKey property.

ImportFromFile Method (SSHKeyManager Component)

Loads key from file.

Syntax

• C#
• VB.NET

public void ImportFromFile(string path, string password);

Public Sub ImportFromFile(ByVal Path As String, ByVal Password As String)

Remarks

Use this method to read a key stored in a file. Path specifies the full path to the file, Password is a password to decrypt the private key.

ImportFromStream Method (SSHKeyManager Component)

Loads key from stream.

Syntax

• C#
• VB.NET

public void ImportFromStream(System.IO.Stream stream, string password);

Public Sub ImportFromStream(ByVal Stream As System.IO.Stream, ByVal Password As String)

Remarks

Use this method to read a key stored in a stream. Password specifies a password to decrypt the private key.

SetKeyParam Method (SSHKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

• C#
• VB.NET

public void SetKeyParam(string name, byte[] value);

Public Sub SetKeyParam(ByVal Name As String, ByVal Value As Byte())

Remarks

Use this method to set an algorithm-specific key parameter.

SetKeyParamStr Method (SSHKeyManager Component)

Sets an algorithm-specific key parameter.

Syntax

• C#
• VB.NET

public void SetKeyParamStr(string name, string valueStr);

Public Sub SetKeyParamStr(ByVal Name As String, ByVal ValueStr As String)

Remarks

Use this method to set an algorithm-specific key parameter provided in a string.

Error Event (SSHKeyManager Component)

Information about errors during SSH key management.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, SshkeymanagerErrorEventArgs e);

public class SshkeymanagerErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As SshkeymanagerErrorEventArgs)

Public Class SshkeymanagerErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The event is fired in case of exceptional conditions during key management.

ErrorCode contains an error code and Description contains a textual description of the error.

Notification Event (SSHKeyManager Component)

This event notifies the application about an underlying control flow event.

Syntax

• C#
• VB.NET

public event OnNotificationHandler OnNotification;

public delegate void OnNotificationHandler(object sender, SshkeymanagerNotificationEventArgs e);

public class SshkeymanagerNotificationEventArgs : EventArgs {
  public string EventID { get; }
  public string EventParam { get; }
}

Public Event OnNotification As OnNotificationHandler

Public Delegate Sub OnNotificationHandler(sender As Object, e As SshkeymanagerNotificationEventArgs)

Public Class SshkeymanagerNotificationEventArgs Inherits EventArgs
  Public ReadOnly Property EventID As String
  Public ReadOnly Property EventParam As String
End Class

Remarks

The component fires this event to let the application know about some event, occurrence, or milestone in the component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in the EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

Constructors

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count, string password);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] certBytes, int certStartIndex, int certCount, byte[] keyBytes, int keyStartIndex, int keyCount, string password);

Public Certificate(ByVal CertBytes As Byte(), ByVal CertStartIndex As Integer, ByVal CertCount As Integer, ByVal KeyBytes As Byte(), ByVal KeyStartIndex As Integer, ByVal KeyCount As Integer, ByVal Password As String)

Loads the X.509 certificate from a memory buffer. CertBytes is a buffer containing the raw certificate data. CertStartIndex and CertCount specify the number of bytes to be read from the buffer, respectively. KeyBytes is a buffer containing the private key data. KeyStartIndex and KeyCount specify the starting position and number of bytes to be read from the buffer, respectively. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(byte[] bytes, int startIndex, int count);

Public Certificate(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads the X.509 certificate from a memory buffer. Bytes is a buffer containing the raw certificate data. StartIndex and Count specify the starting position and number of bytes to be read from the buffer, respectively.

• C#
• VB.NET

public Certificate(string path, string password);

Public Certificate(ByVal Path As String, ByVal Password As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string certPath, string keyPath, string password);

Public Certificate(ByVal CertPath As String, ByVal KeyPath As String, ByVal Password As String)

Loads the X.509 certificate from a file. CertPath specifies the full path to the file containing the certificate data. KeyPath specifies the full path to the file containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(string path);

Public Certificate(ByVal Path As String)

Loads the X.509 certificate from a file. Path specifies the full path to the file containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream);

Public Certificate(ByVal Stream As System.IO.Stream)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

• C#
• VB.NET

public Certificate(System.IO.Stream stream, string password);

Public Certificate(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate(System.IO.Stream certStream, System.IO.Stream keyStream, string password);

Public Certificate(ByVal CertStream As System.IO.Stream, ByVal KeyStream As System.IO.Stream, ByVal Password As String)

Loads the X.509 certificate from a stream. CertStream is a stream containing the certificate data. KeyStream is a stream containing the private key. Password is a password encrypting the certificate.

• C#
• VB.NET

public Certificate();

Public Certificate()

Creates a new object with default field values.

CryptoKey Type

This container represents a cryptographic key.

Remarks

This type is a universal placeholder for cryptographic keys.

Fields

Constructors

• C#
• VB.NET

public CryptoKey();

Public CryptoKey()

Creates an empty crypto key object.

SSHKey Type

SSHKey is used to store information about single compound public-key algorithm (such as RSA or DSA) key.

Remarks

SSH keys are used to secure the SSH protocol flow. They support different algorithms and key lengths, a very typical example being RSA-2048 bits.

Fields

Constructors

• C#
• VB.NET

public SSHKey(byte[] bytes, int startIndex, int count, string password);

Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer, ByVal Password As String)

Loads private key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly. Provide a Password to decrypt the key.

• C#
• VB.NET

public SSHKey(byte[] bytes, int startIndex, int count);

Public SSHKey(ByVal Bytes As Byte(), ByVal StartIndex As Integer, ByVal Count As Integer)

Loads public key from the Bytes buffer. Parameters StartIndex and Count specify the starting index of the key data and its length, correspondingly.

• C#
• VB.NET

public SSHKey(System.IO.Stream stream, string password);

Public SSHKey(ByVal Stream As System.IO.Stream, ByVal Password As String)

Loads private key from the stream. Provide a Password to decrypt the key.

• C#
• VB.NET

public SSHKey(System.IO.Stream stream);

Public SSHKey(ByVal Stream As System.IO.Stream)

Loads public key from the stream.

• C#
• VB.NET

public SSHKey(string path, string password);

Public SSHKey(ByVal Path As String, ByVal Password As String)

Loads private key from the file. Provide a Path to the file and Password to decrypt the key.

• C#
• VB.NET

public SSHKey(string path);

Public SSHKey(ByVal Path As String)

Loads public key from the file specified by Path .

• C#
• VB.NET

public SSHKey();

Public SSHKey()

Creates a new key.

Config Settings (SSHKeyManager Component)

SSHKeyManager Config Settings

Base Config Settings

Trappable Errors (SSHKeyManager Component)

SSHKeyManager Errors