PGPKeyring Class

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyring class accesses and manages PGP keyring files.

Syntax

secureblackbox.Pgpkeyring

Remarks

PGPKeyring is used to hold and access PGP keys. It contains information about both public keys and secret keys, which are usually stored in two separate files: "public keyring" and "secret keyring", respectively.

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

FIPSMode Property (PGPKeyring Class)

Reserved.

Syntax

public boolean isFIPSMode();


public void setFIPSMode(boolean FIPSMode);

Default Value

False

Remarks

This property is reserved for future use.

Opened Property (PGPKeyring Class)

Indicates if the keyring is in an opened state.

Syntax

public boolean isOpened();

Default Value

False

Remarks

If the keyring is open, it means that you can access, add, or removes keys from it.

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

PinnedKey Property (PGPKeyring Class)

A PGP key that is being manipulated on.

Syntax

public PGPKey getPinnedKey();


public void setPinnedKey(PGPKey pinnedKey);

Remarks

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

This property is not available at design time.

Please refer to the PGPKey type for a complete list of fields.

PublicKeys Property (PGPKeyring Class)

Public keys available in the keyring.

Syntax

public PGPKeyList getPublicKeys();

Remarks

This property populates a collection of all public keys contained in the keyring.

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

Please refer to the PGPKey type for a complete list of fields.

SecretKeys Property (PGPKeyring Class)

Secret keys available in the keyring.

Syntax

public PGPKeyList getSecretKeys();

Remarks

This property populates a collection of all secret keys contained in the keyring.

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

Please refer to the PGPKey type for a complete list of fields.

SelectedPublicKeys Property (PGPKeyring Class)

The public keys matching the selection criteria.

Syntax

public PGPKeyList getSelectedPublicKeys();

Remarks

This property contains all the public keys that match the selection filter passed to Select method.

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

Please refer to the PGPKey type for a complete list of fields.

SelectedSecretKeys Property (PGPKeyring Class)

The secret keys matching the selection criteria.

Syntax

public PGPKeyList getSelectedSecretKeys();

Remarks

This property contains all the secret keys that match the selection filter passed to Select method.

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

Please refer to the PGPKey type for a complete list of fields.

AddFromBytes Method (Pgpkeyring Class)

Adds an existing key to the keyring.

Syntax

public void addFromBytes(byte[] bytes);

Remarks

Use this method to add a key stored in a byte array to the keyring.

AddFromFile Method (Pgpkeyring Class)

Adds an existing key to the keyring.

Syntax

public void addFromFile(String filename);

Remarks

Use this method to add a key stored in a file to the keyring.

AddFromFiles Method (Pgpkeyring Class)

Adds a collection of keys to the keyring.

Syntax

public void addFromFiles(String publicKeyringFile, String secretKeyringFile);

Remarks

Use this method to add keys stored in two separate keyring files to the keyring.

AddFromStream Method (Pgpkeyring Class)

Adds a key to the keyring.

Syntax

public void addFromStream(java.io.InputStream stream);

Remarks

Use this method to add a key contained in Stream to the keyring.

AddFromStreams Method (Pgpkeyring Class)

Adds a collection of keys to the keyring.

Syntax

public void addFromStreams(java.io.InputStream publicKeyringStream, java.io.InputStream secretKeyringStream);

Remarks

Use this method to add keys stored in two separate keyring streams to the keyring.

AddPinned Method (Pgpkeyring Class)

Adds a pinned secret key to the keyring.

Syntax

public void addPinned();

Remarks

Use this method to add a key provided via PinnedKey to the keyring. This can be a public or secret key.

Clear Method (Pgpkeyring Class)

Removes all the keys from the keyring.

Syntax

public void clear();

Remarks

Use this method to remove all the items from the keyring.

Close Method (Pgpkeyring Class)

Closes the keyring.

Syntax

public void close();

Remarks

Use this method to close the keyring and release any associated memory resources.

Config Method (Pgpkeyring Class)

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, 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.

CreateNew Method (Pgpkeyring Class)

Creates a new empty keyring.

Syntax

public void createNew();

Remarks

Use this method to initialize a new empty keyring.

DoAction Method (Pgpkeyring Class)

Performs an additional action.

Syntax

public String doAction(String actionID, String actionParams);

Remarks

DoAction is a generic method available in every class. 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;....

Load Method (Pgpkeyring Class)

Loads a keyring from disk.

Syntax

public void load(String publicKeyringFile, String secretKeyringFile);

Remarks

Use this method to load a keyring (usually stored in two files) to the keyring object. If you only have it in one file, pass an empty string as the second parameter.

LoadFromBytes Method (Pgpkeyring Class)

Loads a keyring from two byte arrays.

Syntax

public void loadFromBytes(byte[] publicKeyring, byte[] secretKeyring);

Remarks

Use this method to load a keyring from two byte arrays. Keyring are typically stored in the form of two files (public and secret), but if you only have one file, pass an empty array as the second parameter.

LoadFromStreams Method (Pgpkeyring Class)

Loads a keyring from two streams.

Syntax

public void loadFromStreams(java.io.InputStream publicKeyringStream, java.io.InputStream secretKeyringStream);

Remarks

Use this method to load a keyring (usually stored in two objects, public and secret) to the keyring object. If you only one keyring object/file, pass null as the second parameter.

RemoveByID Method (Pgpkeyring Class)

Removes key by its ID.

Syntax

public void removeByID(String keyID);

Remarks

Call this method to remove the specified key from the keyring.

RemovePublic Method (Pgpkeyring Class)

Removes the specified public key from the keyring.

Syntax

public void removePublic(int index);

Remarks

Use this method to remove a public key from the keyring. Use Index to pass the index of the key to be removed.

RemoveSecret Method (Pgpkeyring Class)

Removes the specified secret key from the keyring.

Syntax

public void removeSecret(int index);

Remarks

Use this method to remove a secret key from the keyring. Use Index to pass the index of the key to be removed.

Save Method (Pgpkeyring Class)

Saves the keyring to disk.

Syntax

public void save(String publicKeyringFile, String secretKeyringFile);

Remarks

Use this method to save the keyring to disk. PGP software typically uses two files to store keyrings, public and private.

SaveToBytes Method (Pgpkeyring Class)

Saves the keyring to a byte array.

Syntax

public byte[] saveToBytes(boolean secret);

Remarks

Use this method to save the keyring to a byte array. PGP software typically uses two files to store keyrings. Use Secret parameter to specify which part of the keyring you would like to save (public or secret).

SaveToStreams Method (Pgpkeyring Class)

Saves the keyring to streams.

Syntax

public void saveToStreams(java.io.OutputStream publicKeyringStream, java.io.OutputStream secretKeyringStream);

Remarks

Use this method to save the keyring to streams. PGP software typically uses two files to store keyrings, public and private.

Select Method (Pgpkeyring Class)

Filters a selection of keys from the keyring using a template.

Syntax

public void select(String filter, boolean secretOnly, int maxCount);

Remarks

Use this method to get a list of keys that satisfy the Filter criteria. The filter should follow the "Name=Value" format, where Name can be one of the following: userid, fp, fingerprint, and keyid.

Set SecretOnly to True to only search for secret keys. MaxCount allows to limit the number of keys returned.

Once the method completes, the keys that match the criteria will be available in SelectedPublicKeys and SelectedSecretKeys properties.

Error Event (Pgpkeyring Class)

Information about errors during PGP key management.

Syntax

public class DefaultPgpkeyringEventListener implements PgpkeyringEventListener {
  ...
  public void error(PgpkeyringErrorEvent e) {}
  ...
}

public class PgpkeyringErrorEvent {
  public int errorCode;
  public String description;
}

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 (Pgpkeyring Class)

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

Syntax

public class DefaultPgpkeyringEventListener implements PgpkeyringEventListener {
  ...
  public void notification(PgpkeyringNotificationEvent e) {}
  ...
}

public class PgpkeyringNotificationEvent {
  public String eventID;
  public String eventParam;
}

Remarks

The class fires this event to let the application know about some event, occurrence, or milestone in the class. 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 class, 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

public PGPKey();

Creates an empty PGP key object.

public PGPKey( filename);

Create a PGP key object from a key file.

Config Settings (Pgpkeyring Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

PGPKeyring Config Settings

Base Config Settings

Trappable Errors (Pgpkeyring Class)

PGPKeyring Errors

	1048577   Invalid parameter value (SB_ERROR_INVALID_PARAMETER)
	1048578   Class is configured incorrectly (SB_ERROR_INVALID_SETUP)
	1048579   Operation cannot be executed in the current state (SB_ERROR_INVALID_STATE)
	1048580   Attempt to set an invalid value to a property (SB_ERROR_INVALID_VALUE)
	1048581   Certificate does not have its private key loaded (SB_ERROR_NO_PRIVATE_KEY)
	1048581   Cancelled by the user (SB_ERROR_CANCELLED_BY_USER) 
	27262977   File does not exist (SB_ERROR_PGP_FILE_NOT_EXISTS)
	27262978   Invalid key (SB_ERROR_PGP_INVALID_KEY)
	27262979   No public key (SB_ERROR_PGP_NO_PUBLIC_KEY)
	27262980   No secret key (SB_ERROR_PGP_NO_SECRET_KEY)
	27262981   Not found (SB_ERROR_PGP_NOT_FOUND)
	27262982   Operation cannot be performed on a subkey (SB_ERROR_PGP_OPERATION_ON_SUBKEY)