PGPKeyManager Component

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager component manages PGP keys.

Syntax

nsoftware.SecureBlackbox.PGPKeyManager

Remarks

PGPKeyManager allows you to load, save, generate, import, and export PGP 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.

Key Property (PGPKeyManager Component)

The key to manipulate on.

Syntax

• C#
• VB.NET

public PGPKey Key { get; }

Public ReadOnly Property Key As PGPKey

Remarks

Use this property to specify the key to perform operations on.

This property is read-only.

PinnedKey Property (PGPKeyManager Component)

A PGP key that is being manipulated on.

Syntax

• C#
• VB.NET

public PGPKey PinnedKey { get; set; }

Public Property PinnedKey As PGPKey

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

Signatures Property (PGPKeyManager Component)

Signatures available in the key.

Syntax

• C#
• VB.NET

public PGPSignatureList Signatures { get; }

Public ReadOnly Property Signatures As PGPSignatureList

Remarks

This property populates a collection of all signatures contained in the key.

This property is read-only and not available at design time.

SigningKey Property (PGPKeyManager Component)

A PGP key that is being manipulated on.

Syntax

• C#
• VB.NET

public PGPKey SigningKey { get; set; }

Public Property SigningKey As PGPKey

Remarks

Use this property to specify a key to perform operations on, such as adding.

This property is not available at design time.

Subkeys Property (PGPKeyManager Component)

PGP subkeys available in the key.

Syntax

• C#
• VB.NET

public PGPKeyList Subkeys { get; }

Public ReadOnly Property Subkeys As PGPKeyList

Remarks

This property populates a collection of all subkeys contained in the key.

This property is read-only and not available at design time.

Users Property (PGPKeyManager Component)

Users available in the key.

Syntax

• C#
• VB.NET

public PGPUserList Users { get; }

Public ReadOnly Property Users As PGPUserList

Remarks

This property populates a collection of all users contained in the key.

This property is read-only and not available at design time.

ChangePassphrase Method (PGPKeyManager Component)

Changes the password of the secret key.

Syntax

• C#
• VB.NET

public void ChangePassphrase(string oldPassphrase, string newPassphrase);

Public Sub ChangePassphrase(ByVal OldPassphrase As String, ByVal NewPassphrase As String)

Remarks

Call this method to change the password that protects the secret key.

ChangeProtection Method (PGPKeyManager Component)

Changes the protection level of the secret key.

Syntax

• C#
• VB.NET

public void ChangeProtection(string oldPassphrase, string newPassphrase, int protType, string encAlgorithm, string hashAlgorithm);

Public Sub ChangeProtection(ByVal OldPassphrase As String, ByVal NewPassphrase As String, ByVal ProtType As Integer, ByVal EncAlgorithm As String, ByVal HashAlgorithm As String)

Remarks

Use this method to change the protection level of the Key.

OldPassphrase specifies the current password to decrypt the key, NewPassphrase is the new password for the key, ProtType is the new protection type (see Protection for more details), EncAlgorithm is the key encryption algorithm, and

CheckPassphrase Method (PGPKeyManager Component)

Checks if the password matches the secret key.

Syntax

• C#
• VB.NET

public bool CheckPassphrase(string passphrase);

Public Function CheckPassphrase(ByVal Passphrase As String) As Boolean

Remarks

Use this method to check if a password can decrypt the Key.

Config Method (PGPKeyManager 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.

CreateKey Method (PGPKeyManager Component)

Generates a new key.

Syntax

• C#
• VB.NET

public void CreateKey(int version, string algorithm, int bits, string validTo, string password);

Public Sub CreateKey(ByVal Version As Integer, ByVal Algorithm As String, ByVal Bits As Integer, ByVal ValidTo As String, ByVal Password As String)

Remarks

Use this method to generate a new key with the provided parameters.

CreateSubkey Method (PGPKeyManager Component)

Generates a new subkey.

Syntax

• C#
• VB.NET

public void CreateSubkey(string algorithm, int bits, string validTo, string password);

Public Sub CreateSubkey(ByVal Algorithm As String, ByVal Bits As Integer, ByVal ValidTo As String, ByVal Password As String)

Remarks

Use this method to generate a new subkey with the provided parameters.

CreateUser Method (PGPKeyManager Component)

Adds a user to an existing key.

Syntax

• C#
• VB.NET

public void CreateUser(string username);

Public Sub CreateUser(ByVal Username As String)

Remarks

Use this method to add a user to an existing key. A typical format for a PGP key usage is "Name <email>", for example "John Johnson <john@johnson.com>".

DoAction Method (PGPKeyManager 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 (PGPKeyManager Component)

Serializes the key to a byte array.

Syntax

• C#
• VB.NET

public byte[] ExportBytes(bool secret);

Public Function ExportBytes(ByVal Secret As Boolean) As Byte()

Remarks

Use this method to save the Key (both the public and secret parts) to a byte array.

ExportToFile Method (PGPKeyManager Component)

Exports the key to a file.

Syntax

• C#
• VB.NET

public void ExportToFile(string fileName, bool secret);

Public Sub ExportToFile(ByVal FileName As String, ByVal Secret As Boolean)

Remarks

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

ExportToStream Method (PGPKeyManager Component)

Exports the key to a stream.

Syntax

• C#
• VB.NET

public void ExportToStream(System.IO.Stream keyStream, bool secret);

Public Sub ExportToStream(ByVal KeyStream As System.IO.Stream, ByVal Secret As Boolean)

Remarks

Use this method to save the Key (both the public and secret parts) to a stream pointed by Stream.

GeneratePair Method (PGPKeyManager Component)

Generates a new pair of PGP keys.

Syntax

• C#
• VB.NET

public void GeneratePair(int version, string username, int strength, string validTo, string password);

Public Sub GeneratePair(ByVal Version As Integer, ByVal Username As String, ByVal Strength As Integer, ByVal ValidTo As String, ByVal Password As String)

Remarks

Use this method to create a standard key-subkey pair. This is the primary method for generating conformant PGP keys.

Pass the user ID of the new key via the Username property. This typically should be in the format of User Name <user@email>, for example Robert Frost <robert@frost.com>, but generally can be an arbitrary text string.

This method generates a 'standard' keypair based on the Version and Strength parameters. This can range from RSA keys for version 3 to strong Ed25519 keys for version 6.

The following PGP key versions and strengths are supported:

Provide the key encryption password and the validity period in days via the Password and ValidTo parameters.

ImportBytes Method (PGPKeyManager Component)

Loads a key from a byte array.

Syntax

• C#
• VB.NET

public void ImportBytes(byte[] key);

Public Sub ImportBytes(ByVal Key As Byte())

Remarks

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

ImportFromFile Method (PGPKeyManager Component)

Loads a key from a file.

Syntax

• C#
• VB.NET

public void ImportFromFile(string fileName);

Public Sub ImportFromFile(ByVal FileName As String)

Remarks

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

ImportFromStream Method (PGPKeyManager Component)

Loads a key from a stream.

Syntax

• C#
• VB.NET

public void ImportFromStream(System.IO.Stream keyStream);

Public Sub ImportFromStream(ByVal KeyStream As System.IO.Stream)

Remarks

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

ImportPinned Method (PGPKeyManager Component)

Loads a key from a pinned key object.

Syntax

• C#
• VB.NET

public void ImportPinned();

Public Sub ImportPinned()

Remarks

Use this method to load a PGP key from a PinnedKey object. This is an easy way to import a key object from a keyring.

RemoveSignature Method (PGPKeyManager Component)

Unbinds the specified signature from the key, subkey or user.

Syntax

• C#
• VB.NET

public void RemoveSignature(int index);

Public Sub RemoveSignature(ByVal Index As Integer)

Remarks

Use this method to remove the specified signature from the list of Signatures bound to the key, subkey or user.

RemoveSubkey Method (PGPKeyManager Component)

Removes the specified subkey from the key.

Syntax

• C#
• VB.NET

public void RemoveSubkey(int index);

Public Sub RemoveSubkey(ByVal Index As Integer)

Remarks

Use this method to remove the subkey referred by its Index from the key.

RemoveUser Method (PGPKeyManager Component)

Unbinds the specified user from the key.

Syntax

• C#
• VB.NET

public void RemoveUser(int index);

Public Sub RemoveUser(ByVal Index As Integer)

Remarks

Use this method to remove the specified user from the list of UserIDs bound to the key.

Reset Method (PGPKeyManager Component)

Creates a new empty keyring.

Syntax

• C#
• VB.NET

public void Reset();

Public Sub Reset()

Remarks

Use this method to initialize a new empty keyring.

RevokeKey Method (PGPKeyManager Component)

Revokes the key.

Syntax

• C#
• VB.NET

public void RevokeKey(int reason, string comment);

Public Sub RevokeKey(ByVal Reason As Integer, ByVal Comment As String)

Remarks

Use this method to revoke the key by adding a revocation signature.

RevokeSubkey Method (PGPKeyManager Component)

Revokes the key's subkey.

Syntax

• C#
• VB.NET

public void RevokeSubkey(int index, int reason, string comment);

Public Sub RevokeSubkey(ByVal Index As Integer, ByVal Reason As Integer, ByVal Comment As String)

Remarks

Use this method to revoke the subkey with a given Index by adding a revocation signature.

RevokeUser Method (PGPKeyManager Component)

Revokes a user certification.

Syntax

• C#
• VB.NET

public void RevokeUser(int index, int reason, string comment);

Public Sub RevokeUser(ByVal Index As Integer, ByVal Reason As Integer, ByVal Comment As String)

Remarks

Use this method to revoke the user with the specified Index by adding a revocation signature to the key.

SignKey Method (PGPKeyManager Component)

Sign the key.

Syntax

• C#
• VB.NET

public void SignKey(string keyValidTo, string hashAlgorithm, string preferredAlgs, int keyFlags);

Public Sub SignKey(ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal PreferredAlgs As String, ByVal KeyFlags As Integer)

Remarks

Use this method to sign the key.

SignSubkey Method (PGPKeyManager Component)

Sign the key's subkey.

Syntax

• C#
• VB.NET

public void SignSubkey(int index, string keyValidTo, string hashAlgorithm, string preferredAlgs, int keyFlags);

Public Sub SignSubkey(ByVal Index As Integer, ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal PreferredAlgs As String, ByVal KeyFlags As Integer)

Remarks

Use this method to sign the subkey with a given Index.

SignUser Method (PGPKeyManager Component)

Sign a user certification.

Syntax

• C#
• VB.NET

public void SignUser(int index, string keyValidTo, string hashAlgorithm, bool primary, int certType);

Public Sub SignUser(ByVal Index As Integer, ByVal KeyValidTo As String, ByVal HashAlgorithm As String, ByVal Primary As Boolean, ByVal CertType As Integer)

Remarks

Use this method to sign the user with the specified Index.

Verify Method (PGPKeyManager Component)

Verifies the integrity of a key signature.

Syntax

• C#
• VB.NET

public bool Verify(int index);

Public Function Verify(ByVal Index As Integer) As Boolean

Remarks

Use this method to validate a key signature. Provide the index of the signature as a parameter.

Error Event (PGPKeyManager Component)

Information about errors during PGP key management.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

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

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

Public Event OnError As OnErrorHandler

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

Public Class PGPKeyManagerErrorEventArgs 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.

KeyPassphraseNeeded Event (PGPKeyManager Component)

Requests a key protection password from the application.

Syntax

• C#
• VB.NET

public event OnKeyPassphraseNeededHandler OnKeyPassphraseNeeded;

public delegate void OnKeyPassphraseNeededHandler(object sender, PGPKeyManagerKeyPassphraseNeededEventArgs e);

public class PGPKeyManagerKeyPassphraseNeededEventArgs : EventArgs {
  public string KeyID { get; }
  public string UserID { get; }
  public bool MainKey { get; }
  public string Passphrase { get; set; }
  public bool Skip { get; set; }
}

Public Event OnKeyPassphraseNeeded As OnKeyPassphraseNeededHandler

Public Delegate Sub OnKeyPassphraseNeededHandler(sender As Object, e As PGPKeyManagerKeyPassphraseNeededEventArgs)

Public Class PGPKeyManagerKeyPassphraseNeededEventArgs Inherits EventArgs
  Public ReadOnly Property KeyID As String
  Public ReadOnly Property UserID As String
  Public ReadOnly Property MainKey As Boolean
  Public Property Passphrase As String
  Public Property Skip As Boolean
End Class

Remarks

The component fires this event to request a secret key passphrase from the application. Note that this event asks for a key protection passphrase rather than a message protection passphrase. The component fires it when it attempts to use a secret key to sign the data.

This event is fired for every protected secret key residing in SigningKeys. KeyID specifies the key for which the password is requested, and UserID identifies its user. MainKey tells whether the key is a master key or a subkey.

The handler should provide password via the Passphrase parameter, or set Skip to True to skip this key.

For each key KeyPassphraseNeeded is called in a loop until the correct password is provided or the maximum number of password attempts reached.

Notification Event (PGPKeyManager 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, PGPKeyManagerNotificationEventArgs e);

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

Public Event OnNotification As OnNotificationHandler

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

Public Class PGPKeyManagerNotificationEventArgs 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.

PGPKey Type

This container represents a PGP key.

Remarks

OpenPGP standard supports several types of keys. In our days, a typical OpenPGP keypair actually consists of two cryptographic keys: a primary key and a subkey. The primary key is normally used for signing, while the subkey is used for encryption.

While it is typical for PGP environments to use a primary key/subkey bundle, this is not a must. Sometimes you may come across standalone keys (mainly when dealing with older implementations), as well as whole key trees, each of those carrying a bunch of differently-purposed subkeys bound to the same primary key.

Algorithm-wise, OpenPGP keys also differ. Generally speaking, OpenPGP supports the following public key algorithms: RSA, Elgamal (often incorrectly referred to as DH), DSA, ECDH and ECDSA. When it comes to primary key/subkey bundles, DSA/Elgamal, RSA/RSA and ECDSA/ECDH pairs are typically used. Although there's no restriction on algorithm bundles, and, e.g. a ECDSA/Elgamal key bundle is perfectly possible, such combination is rarely used in practice.

A typical OpenPGP key is associated with some kind of user ID (Username). It is normally represented with a user's e-mail address, while in theory can be any piece of text. The secret part of the OpenPGP keypair is protected with a password (Passphrase).

Fields

Constructors

• C#
• VB.NET

public PGPKey();

Public PGPKey()

• C#
• VB.NET

public PGPKey(string fileName);

Public PGPKey(ByVal FileName As String)

PGPSignature Type

A container for PGP signature properties.

Remarks

PGPSignature contains details and validation information for a PGP signature.

Fields

Constructors

• C#
• VB.NET

public PGPSignature();

Public PGPSignature()

PGPUser Type

A container for PGP user properties.

Remarks

PGPUser contains details information for a PGP user.

Fields

Constructors

• C#
• VB.NET

public PGPUser();

Public PGPUser()

Config Settings (PGPKeyManager Component)

PGPKeyManager Config Settings

Base Config Settings

Trappable Errors (PGPKeyManager Component)

PGPKeyManager Errors