PGPKeyManager Module

Properties   Methods   Events   Config Settings   Errors  

The PGPKeyManager module manages PGP keys.

Syntax

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 module with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

FIPSMode Property (PGPKeyManager Module)

Reserved.

Syntax

• Swift
• Objective-C

public var fipsMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=FIPSMode,setter=setFIPSMode:) BOOL FIPSMode;

- (BOOL)FIPSMode;
- (void)setFIPSMode :(BOOL)newFIPSMode;

Default Value

False

Remarks

This property is reserved for future use.

Key Property (PGPKeyManager Module)

The key to manipulate on.

Syntax

• Swift
• Objective-C

public var key: PGPKey {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keyBitsInKey,setter=setKeyBitsInKey:) int keyBitsInKey;

- (int)keyBitsInKey;
- (void)setKeyBitsInKey :(int)newKeyBitsInKey;

@property (nonatomic,readwrite,assign,getter=keyCurve,setter=setKeyCurve:) NSString* keyCurve;

- (NSString*)keyCurve;
- (void)setKeyCurve :(NSString*)newKeyCurve;

@property (nonatomic,readwrite,assign,getter=keyEncryptionAlgorithm,setter=setKeyEncryptionAlgorithm:) NSString* keyEncryptionAlgorithm;

- (NSString*)keyEncryptionAlgorithm;
- (void)setKeyEncryptionAlgorithm :(NSString*)newKeyEncryptionAlgorithm;

@property (nonatomic,readwrite,assign,getter=keyExpires,setter=setKeyExpires:) int keyExpires;

- (int)keyExpires;
- (void)setKeyExpires :(int)newKeyExpires;

@property (nonatomic,readwrite,assign,getter=keyHandle,setter=setKeyHandle:) long long keyHandle;

- (long long)keyHandle;
- (void)setKeyHandle :(long long)newKeyHandle;

@property (nonatomic,readwrite,assign,getter=keyHashAlgorithm,setter=setKeyHashAlgorithm:) NSString* keyHashAlgorithm;

- (NSString*)keyHashAlgorithm;
- (void)setKeyHashAlgorithm :(NSString*)newKeyHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=keyOldPacketFormat,setter=setKeyOldPacketFormat:) BOOL keyOldPacketFormat;

- (BOOL)keyOldPacketFormat;
- (void)setKeyOldPacketFormat :(BOOL)newKeyOldPacketFormat;

@property (nonatomic,readwrite,assign,getter=keyPassphrase,setter=setKeyPassphrase:) NSString* keyPassphrase;

- (NSString*)keyPassphrase;
- (void)setKeyPassphrase :(NSString*)newKeyPassphrase;

@property (nonatomic,readwrite,assign,getter=keyProtection,setter=setKeyProtection:) int keyProtection;

- (int)keyProtection;
- (void)setKeyProtection :(int)newKeyProtection;

@property (nonatomic,readwrite,assign,getter=keyPublicKeyAlgorithm,setter=setKeyPublicKeyAlgorithm:) NSString* keyPublicKeyAlgorithm;

- (NSString*)keyPublicKeyAlgorithm;
- (void)setKeyPublicKeyAlgorithm :(NSString*)newKeyPublicKeyAlgorithm;

@property (nonatomic,readwrite,assign,getter=keyQBits,setter=setKeyQBits:) int keyQBits;

- (int)keyQBits;
- (void)setKeyQBits :(int)newKeyQBits;

@property (nonatomic,readwrite,assign,getter=keyUsername,setter=setKeyUsername:) NSString* keyUsername;

- (NSString*)keyUsername;
- (void)setKeyUsername :(NSString*)newKeyUsername;

 

Default Value

-1

Remarks

This property is read-only.

AddSubkey Method (PGPKeyManager Module)

Adds a new subkey to the Key.

Syntax

• Swift
• Objective-C

public func addSubkey(bits: Int32, algorithm: String, expires: Int32) throws -> Void

- (void)addSubkey:(int)bits :(NSString*)algorithm :(int)expires;

Remarks

Use this method to add a subkey to a key. Note that the key you are adding the subkey to needs to contain its secret counterpart to be able to sign the new subkey.

Bits specifies the number of bits in the new subkey, Expires is the new subkey's expiration time and date, and Algorithm specifies its public key algorithm:

BindUser Method (PGPKeyManager Module)

Binds a new UserID to the Key.

Syntax

• Swift
• Objective-C

public func bindUser(username: String) throws -> Void

- (void)bindUser:(NSString*)username;

Remarks

Use this method to add a new Username as an owner of the Key.

Note that the key needs to contain its secret counterpart to be able to sign the new user ID.

ChangePassphrase Method (PGPKeyManager Module)

Changes the password of the secret key.

Syntax

• Swift
• Objective-C

public func changePassphrase(oldPassphrase: String, newPassphrase: String) throws -> Void

- (void)changePassphrase:(NSString*)oldPassphrase :(NSString*)newPassphrase;

Remarks

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

ChangeProtection Method (PGPKeyManager Module)

Changes the protection level of the secret key.

Syntax

• Swift
• Objective-C

public func changeProtection(oldPassphrase: String, newPassphrase: String, protType: Int32, encAlgorithm: String, hashAlgorithm: String) throws -> Void

- (void)changeProtection:(NSString*)oldPassphrase :(NSString*)newPassphrase :(int)protType :(NSString*)encAlgorithm :(NSString*)hashAlgorithm;

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 for more details), EncAlgorithm is the key encryption algorithm, and

CheckPassphrase Method (PGPKeyManager Module)

Checks if the password matches the secret key.

Syntax

• Swift
• Objective-C

public func checkPassphrase(passphrase: String) throws -> Bool

- (BOOL)checkPassphrase:(NSString*)passphrase;

Remarks

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

Config Method (PGPKeyManager Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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.

DoAction Method (PGPKeyManager Module)

Performs an additional action.

Syntax

• Swift
• Objective-C

public func doAction(actionID: String, actionParams: String) throws -> String

- (NSString*)doAction:(NSString*)actionID :(NSString*)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 insencitive) 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;....

ExportKey Method (PGPKeyManager Module)

Serializes the key to a byte array.

Syntax

• Swift
• Objective-C

public func exportKey() throws -> Data

- (NSData*)exportKey;

Remarks

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

ExportPublicKey Method (PGPKeyManager Module)

Exports the public key to a byte array.

Syntax

• Swift
• Objective-C

public func exportPublicKey() throws -> Data

- (NSData*)exportPublicKey;

Remarks

Use this method to save the public key contained in Key to a byte array.

ExportPublicToFile Method (PGPKeyManager Module)

Exports the public key to a file.

Syntax

• Swift
• Objective-C

public func exportPublicToFile(filename: String) throws -> Void

- (void)exportPublicToFile:(NSString*)filename;

Remarks

Use this method to save the public key stored in Key to the file specified by Filename.

ExportToFile Method (PGPKeyManager Module)

Exports the key to a file.

Syntax

• Swift
• Objective-C

public func exportToFile(filename: String) throws -> Void

- (void)exportToFile:(NSString*)filename;

Remarks

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

Generate Method (PGPKeyManager Module)

Generates a new single PGP key.

Syntax

• Swift
• Objective-C

public func generate() throws -> Void

- (void)generate;

Remarks

Call this method after setting up relevant fields of Key to generate a new PGP key. This method generates a 'standalone' key without subkeys. Use GeneratePair to generate a pair of a main key and a subkey.

Most PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

GenerateLegacy Method (PGPKeyManager Module)

Generates a new key in the old format.

Syntax

• Swift
• Objective-C

public func generateLegacy(username: String, bits: Int32, password: String, expires: Int32) throws -> Void

- (void)generateLegacy:(NSString*)username :(int)bits :(NSString*)password :(int)expires;

Remarks

Use this method when you need to generate an RSA key in the old (PGP 2.6.x) format.

Username specifies the user of the key, Bits is the key length in bits. Provide Password for the key and its expiration date and time via Expires.

Only use this method where you want to work with very old PGP software. While still providing a decent level of protection (subject to key length, of course), legacy keys are rarely used these days, and have almost everywhere been replaced with new-style keys.

Most modern PGP implementations work with pairs of keys: the sign-only primary key and the encrypt-only (or encrypt-and-sign) subkey. If you need to generate a conformant PGP key to use with other PGP software, you likely need to use the GeneratePair method.

GeneratePair Method (PGPKeyManager Module)

Generates a new pair of PGP keys.

Syntax

• Swift
• Objective-C

public func generatePair(username: String, keyAlgorithm: String, keyBits: Int32, subKeyAlgorithm: String, subKeyBits: Int32, password: String, expires: Int32) throws -> Void

- (void)generatePair:(NSString*)username :(NSString*)keyAlgorithm :(int)keyBits :(NSString*)subKeyAlgorithm :(int)subKeyBits :(NSString*)password :(int)expires;

Remarks

Use this method to create a new 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.

Set KeyAlgorithm and SubKeyAlgorithm to the public key algorithms that you want to use for the new key. See the full list of algorithms below. Where ECDSA or ECDH algorithm is used, you can specify a particular curve after the algorithm name, separated with the colon: ECDSA:P384 or ECDH:BRAINPOOLP256. KeyBits and SubKeyBits specify the number of bits in the key and the subkey. These parameters can be set to zero if the key length is implicitly defined by the algorithm of the key. For example, ECDSA P256 keys are always 256 bit long, so you may pass 0 as the corresponding KeyBits or SubKeyBits parameter.

Provide the key encryption password and the validity period in days via the Password and Expires parameters. Set Expires to zero to indicate that the key does not expire.

While you can use any combination of algorithms for your key and subkey, most implementations got used to specific hard-wired combinations. Sticking to those will help make sure your keys are understood by other implementations. Typical combinations are:

• EDDSA main key with ECDH:CURVE25519 subkey;
• ECDSA main key with ECDH subkey; both with NIST curves (P256, P384, or P512);
• ECDSA main key with ECDH subkey; both with Brainpool curves (BRAINPOOLP256 or BRAINPOOLP512);
• RSA main key with RSA subkey.

ImportFromFile Method (PGPKeyManager Module)

Loads a key from a file.

Syntax

• Swift
• Objective-C

public func importFromFile(filename: String) throws -> Void

- (void)importFromFile:(NSString*)filename;

Remarks

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

ImportKey Method (PGPKeyManager Module)

Loads a key from a byte array.

Syntax

• Swift
• Objective-C

public func importKey(data: Data) throws -> Void

- (void)importKey:(NSData*)data;

Remarks

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

RemoveSubkey Method (PGPKeyManager Module)

Removes the specified subkey from the key.

Syntax

• Swift
• Objective-C

public func removeSubkey(index: Int32) throws -> Void

- (void)removeSubkey:(int)index;

Remarks

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

RemoveUser Method (PGPKeyManager Module)

Unbinds the specified user from the key.

Syntax

• Swift
• Objective-C

public func removeUser(index: Int32) throws -> Void

- (void)removeUser:(int)index;

Remarks

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

RevokeKey Method (PGPKeyManager Module)

Revokes the key.

Syntax

• Swift
• Objective-C

public func revokeKey() throws -> Void

- (void)revokeKey;

Remarks

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

RevokeSubkey Method (PGPKeyManager Module)

Revokes the key's subkey.

Syntax

• Swift
• Objective-C

public func revokeSubkey(index: Int32) throws -> Void

- (void)revokeSubkey:(int)index;

Remarks

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

RevokeSubkeybyID Method (PGPKeyManager Module)

Revokes the key's subkey.

Syntax

• Swift
• Objective-C

public func revokeSubkeybyID(keyId: String) throws -> Void

- (void)revokeSubkeybyID:(NSString*)keyId;

Remarks

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

RevokeUser Method (PGPKeyManager Module)

Revokes a user certification.

Syntax

• Swift
• Objective-C

public func revokeUser(index: Int32) throws -> Void

- (void)revokeUser:(int)index;

Remarks

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

RevokeUserByName Method (PGPKeyManager Module)

Revokes a user certification.

Syntax

• Swift
• Objective-C

public func revokeUserByName(username: String) throws -> Void

- (void)revokeUserByName:(NSString*)username;

Remarks

Use this method to revoke the certification of the user specified by Username by adding a revocation signature.

Validate Method (PGPKeyManager Module)

Validates the key.

Syntax

• Swift
• Objective-C

public func validate() throws -> Int32

- (int)validate;

Remarks

Call this method to validate signatures over the PGP key and all the subkeys.

Possible result:

Error Event (PGPKeyManager Module)

Information about errors during PGP key management.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)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 (PGPKeyManager Module)

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

Syntax

• Swift
• Objective-C

func onNotification(eventID: String, eventParam: String)

- (void)onNotification:(NSString*)eventID :(NSString*)eventParam;

Remarks

The class 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 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

public init()

Creates an empty PGP key object.

Config Settings (PGPKeyManager Module)

PGPKeyManager Config Settings

Base Config Settings

Trappable Errors (PGPKeyManager Module)

PGPKeyManager Errors