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.

Key Property (PGPKeyManager Module)

The key to manipulate on.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readonly,assign,getter=keyBitsInKey) int keyBitsInKey;

- (int)keyBitsInKey;

@property (nonatomic,readonly,assign,getter=keyCanEncrypt) BOOL keyCanEncrypt;

- (BOOL)keyCanEncrypt;

@property (nonatomic,readonly,assign,getter=keyCanSign) BOOL keyCanSign;

- (BOOL)keyCanSign;

@property (nonatomic,readonly,assign,getter=keyCurve) NSString* keyCurve;

- (NSString*)keyCurve;

@property (nonatomic,readwrite,assign,getter=keyEnabled,setter=setKeyEnabled:) BOOL keyEnabled;

- (BOOL)keyEnabled;
- (void)setKeyEnabled :(BOOL)newKeyEnabled;

@property (nonatomic,readonly,assign,getter=keyEncryptionAlgorithm) NSString* keyEncryptionAlgorithm;

- (NSString*)keyEncryptionAlgorithm;

@property (nonatomic,readonly,assign,getter=keyIsPublic) BOOL keyIsPublic;

- (BOOL)keyIsPublic;

@property (nonatomic,readonly,assign,getter=keyIsSecret) BOOL keyIsSecret;

- (BOOL)keyIsSecret;

@property (nonatomic,readonly,assign,getter=keyIsSubkey) BOOL keyIsSubkey;

- (BOOL)keyIsSubkey;

@property (nonatomic,readonly,assign,getter=keyKeyFP) NSString* keyKeyFP;

- (NSString*)keyKeyFP;

@property (nonatomic,readonly,assign,getter=keyKeyID) NSString* keyKeyID;

- (NSString*)keyKeyID;

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

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

@property (nonatomic,readonly,assign,getter=keyPassphraseValid) BOOL keyPassphraseValid;

- (BOOL)keyPassphraseValid;

@property (nonatomic,readonly,assign,getter=keyPrimaryKeyID) NSString* keyPrimaryKeyID;

- (NSString*)keyPrimaryKeyID;

@property (nonatomic,readonly,assign,getter=keyProtection) int keyProtection;

- (int)keyProtection;

@property (nonatomic,readonly,assign,getter=keyPublicKeyAlgorithm) NSString* keyPublicKeyAlgorithm;

- (NSString*)keyPublicKeyAlgorithm;

@property (nonatomic,readonly,assign,getter=keyQBits) int keyQBits;

- (int)keyQBits;

@property (nonatomic,readonly,assign,getter=keyTimestamp) NSString* keyTimestamp;

- (NSString*)keyTimestamp;

@property (nonatomic,readonly,assign,getter=keyUsername) NSString* keyUsername;

- (NSString*)keyUsername;

@property (nonatomic,readonly,assign,getter=keyValidTo) NSString* keyValidTo;

- (NSString*)keyValidTo;

@property (nonatomic,readonly,assign,getter=keyVersion) int keyVersion;

- (int)keyVersion;

 

Default Value

""

Remarks

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

This property is read-only.

PinnedKey Property (PGPKeyManager Module)

A PGP key that is being manipulated on.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=pinnedKeyHandle,setter=setPinnedKeyHandle:) long long pinnedKeyHandle;

- (long long)pinnedKeyHandle;
- (void)setPinnedKeyHandle :(long long)newPinnedKeyHandle;

 

Default Value

""

Remarks

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

This property is read-only.

Signatures Property (PGPKeyManager Module)

Signatures available in the key.

Syntax

• Swift
• Objective-C

public var signatures: Array<PGPSignature> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=signatureCount) int signatureCount;

- (int)signatureCount;

- (int)signatureCertificationType:(int)signatureIndex;

- (NSString*)signatureCreationTime:(int)signatureIndex;

- (int)signatureExpirationTime:(int)signatureIndex;

- (BOOL)signatureExportable:(int)signatureIndex;

- (long long)signatureHandle:(int)signatureIndex;

- (NSString*)signatureHashAlgorithm:(int)signatureIndex;

- (int)signatureHashMark:(int)signatureIndex;

- (int)signatureKeyExpirationTime:(int)signatureIndex;

- (int)signatureKeyFlags:(int)signatureIndex;

- (BOOL)signatureLegacyFormat:(int)signatureIndex;

- (NSString*)signaturePolicyURL:(int)signatureIndex;

- (NSString*)signaturePreferredAlgorithms:(int)signatureIndex;

- (BOOL)signaturePrimaryUserID:(int)signatureIndex;

- (NSString*)signatureReasonForRevocation:(int)signatureIndex;

- (BOOL)signatureRevocable:(int)signatureIndex;

- (BOOL)signatureRevocation:(int)signatureIndex;

- (int)signatureSignatureClass:(int)signatureIndex;

- (NSString*)signatureSignerKeyID:(int)signatureIndex;

- (NSString*)signatureSignerUserID:(int)signatureIndex;

- (BOOL)signatureStrictlyValid:(int)signatureIndex;

- (NSString*)signatureTarget:(int)signatureIndex;

- (BOOL)signatureTextSignature:(int)signatureIndex;

- (int)signatureTrustAmount:(int)signatureIndex;

- (int)signatureTrustLevel:(int)signatureIndex;

- (BOOL)signatureValidated:(int)signatureIndex;

- (int)signatureValidity:(int)signatureIndex;

- (int)signatureVersion:(int)signatureIndex;

Default Value

""

Remarks

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

This property is read-only.

SigningKey Property (PGPKeyManager Module)

A PGP key that is being manipulated on.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=signingKeyHandle,setter=setSigningKeyHandle:) long long signingKeyHandle;

- (long long)signingKeyHandle;
- (void)setSigningKeyHandle :(long long)newSigningKeyHandle;

 

Default Value

""

Remarks

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

This property is read-only.

Subkeys Property (PGPKeyManager Module)

PGP subkeys available in the key.

Syntax

• Swift
• Objective-C

public var subkeys: Array<PGPKey> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=subkeyCount) int subkeyCount;

- (int)subkeyCount;

- (int)subkeyBitsInKey:(int)subkeyIndex;

- (BOOL)subkeyCanEncrypt:(int)subkeyIndex;

- (BOOL)subkeyCanSign:(int)subkeyIndex;

- (NSString*)subkeyCurve:(int)subkeyIndex;

- (BOOL)subkeyEnabled:(int)subkeyIndex;

- (NSString*)subkeyEncryptionAlgorithm:(int)subkeyIndex;

- (long long)subkeyHandle:(int)subkeyIndex;

- (BOOL)subkeyIsPublic:(int)subkeyIndex;

- (BOOL)subkeyIsSecret:(int)subkeyIndex;

- (BOOL)subkeyIsSubkey:(int)subkeyIndex;

- (NSString*)subkeyKeyFP:(int)subkeyIndex;

- (NSString*)subkeyKeyID:(int)subkeyIndex;

- (NSString*)subkeyPassphrase:(int)subkeyIndex;

- (BOOL)subkeyPassphraseValid:(int)subkeyIndex;

- (NSString*)subkeyPrimaryKeyID:(int)subkeyIndex;

- (int)subkeyProtection:(int)subkeyIndex;

- (NSString*)subkeyPublicKeyAlgorithm:(int)subkeyIndex;

- (int)subkeyQBits:(int)subkeyIndex;

- (NSString*)subkeyTimestamp:(int)subkeyIndex;

- (NSString*)subkeyUsername:(int)subkeyIndex;

- (NSString*)subkeyValidTo:(int)subkeyIndex;

- (int)subkeyVersion:(int)subkeyIndex;

Default Value

""

Remarks

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

This property is read-only.

Users Property (PGPKeyManager Module)

Users available in the key.

Syntax

• Swift
• Objective-C

public var users: Array<PGPUser> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=userCount) int userCount;

- (int)userCount;

- (long long)userHandle:(int)userIndex;

- (NSString*)userUsername:(int)userIndex;

Default Value

""

Remarks

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

This property is read-only.

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.

CreateKey Method (PGPKeyManager Module)

Generates a new key.

Syntax

• Swift
• Objective-C

public func createKey(version: Int32, algorithm: String, bits: Int32, validTo: String, password: String) throws -> Void

- (void)createKey:(int)version :(NSString*)algorithm :(int)bits :(NSString*)validTo :(NSString*)password;

Remarks

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

CreateSubkey Method (PGPKeyManager Module)

Generates a new subkey.

Syntax

• Swift
• Objective-C

public func createSubkey(algorithm: String, bits: Int32, validTo: String, password: String) throws -> Void

- (void)createSubkey:(NSString*)algorithm :(int)bits :(NSString*)validTo :(NSString*)password;

Remarks

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

CreateUser Method (PGPKeyManager Module)

Adds a user to an existing key.

Syntax

• Swift
• Objective-C

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

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

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 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 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 Module)

Serializes the key to a byte array.

Syntax

• Swift
• Objective-C

public func exportBytes(secret: Bool) throws -> Data

- (NSData*)exportBytes:(BOOL)secret;

Remarks

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

ExportToFile Method (PGPKeyManager Module)

Exports the key to a file.

Syntax

• Swift
• Objective-C

public func exportToFile(fileName: String, secret: Bool) throws -> Void

- (void)exportToFile:(NSString*)fileName :(BOOL)secret;

Remarks

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

GeneratePair Method (PGPKeyManager Module)

Generates a new pair of PGP keys.

Syntax

• Swift
• Objective-C

public func generatePair(version: Int32, username: String, strength: Int32, validTo: String, password: String) throws -> Void

- (void)generatePair:(int)version :(NSString*)username :(int)strength :(NSString*)validTo :(NSString*)password;

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 Module)

Loads a key from a byte array.

Syntax

• Swift
• Objective-C

public func importBytes(key: Data) throws -> Void

- (void)importBytes:(NSData*)key;

Remarks

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

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.

ImportPinned Method (PGPKeyManager Module)

Loads a key from a pinned key object.

Syntax

• Swift
• Objective-C

public func importPinned() throws -> Void

- (void)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 Module)

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

Syntax

• Swift
• Objective-C

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

- (void)removeSignature:(int)index;

Remarks

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

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.

Reset Method (PGPKeyManager Module)

Creates a new empty keyring.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Use this method to initialize a new empty keyring.

RevokeKey Method (PGPKeyManager Module)

Revokes the key.

Syntax

• Swift
• Objective-C

public func revokeKey(reason: Int32, comment: String) throws -> Void

- (void)revokeKey:(int)reason :(NSString*)comment;

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, reason: Int32, comment: String) throws -> Void

- (void)revokeSubkey:(int)index :(int)reason :(NSString*)comment;

Remarks

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

RevokeUser Method (PGPKeyManager Module)

Revokes a user certification.

Syntax

• Swift
• Objective-C

public func revokeUser(index: Int32, reason: Int32, comment: String) throws -> Void

- (void)revokeUser:(int)index :(int)reason :(NSString*)comment;

Remarks

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

SignKey Method (PGPKeyManager Module)

Sign the key.

Syntax

• Swift
• Objective-C

public func signKey(keyValidTo: String, hashAlgorithm: String, preferredAlgs: String, keyFlags: Int32) throws -> Void

- (void)signKey:(NSString*)keyValidTo :(NSString*)hashAlgorithm :(NSString*)preferredAlgs :(int)keyFlags;

Remarks

Use this method to sign the key.

SignSubkey Method (PGPKeyManager Module)

Sign the key's subkey.

Syntax

• Swift
• Objective-C

public func signSubkey(index: Int32, keyValidTo: String, hashAlgorithm: String, preferredAlgs: String, keyFlags: Int32) throws -> Void

- (void)signSubkey:(int)index :(NSString*)keyValidTo :(NSString*)hashAlgorithm :(NSString*)preferredAlgs :(int)keyFlags;

Remarks

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

SignUser Method (PGPKeyManager Module)

Sign a user certification.

Syntax

• Swift
• Objective-C

public func signUser(index: Int32, keyValidTo: String, hashAlgorithm: String, primary: Bool, certType: Int32) throws -> Void

- (void)signUser:(int)index :(NSString*)keyValidTo :(NSString*)hashAlgorithm :(BOOL)primary :(int)certType;

Remarks

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

Verify Method (PGPKeyManager Module)

Verifies the integrity of a key signature.

Syntax

• Swift
• Objective-C

public func verify(index: Int32) throws -> Bool

- (BOOL)verify:(int)index;

Remarks

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

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.

KeyPassphraseNeeded Event (PGPKeyManager Module)

Requests a key protection password from the application.

Syntax

• Swift
• Objective-C

func onKeyPassphraseNeeded(keyID: String, userID: String, mainKey: Bool, passphrase: inout String, skip: inout Bool)

- (void)onKeyPassphraseNeeded:(NSString*)keyID :(NSString*)userID :(BOOL)mainKey :(NSString**)passphrase :(int*)skip;

Remarks

The class 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 class 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 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 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 init()

PGPSignature Type

A container for PGP signature properties.

Remarks

PGPSignature contains details and validation information for a PGP signature.

Fields

Constructors

public init()

PGPUser Type

A container for PGP user properties.

Remarks

PGPUser contains details information for a PGP user.

Fields

Constructors

public init()

Config Settings (PGPKeyManager Module)

PGPKeyManager Config Settings

Base Config Settings

Trappable Errors (PGPKeyManager Module)

PGPKeyManager Errors