PGPReader Module

Properties   Methods   Events   Config Settings   Errors  

The PGPReader module unprotects, verifies, and extracts data from protected PGP files.

Syntax

SecureBlackbox.PGPReader

Remarks

PGPReader lets you process PGP messages, and validate and extract the protected data.

PGPReader supports all modern PGP keys and formats, from last-century PGP 2.6.x to the state-of-the art PGP 6. Single- and multi-file, as well as for-your-eyes-only PGP containers are supported.

The use of PGPReader is quite straightforward: you only need to provide the protected data and the keyring files, and the component will do the rest. PGPReader detects the protection parameters, matches them to the keys, and unwraps the protected data automatically.

Preparing keys

Encryption and signing in PGP is done with asymmetric keys (and sometimes with passwords, but that is a far less common scenario). Keys are normally stored in files called keyrings. More often that not they consist of a pair of files: a public keyring (e.g pubring.pkr) and a secret keyring (secring.skr), although there are exceptions. Sometimes, parties provide each other with standalone public keys that they want them to encrypt or verify data with.

Whichever form your keyring takes, use PGPKeyring to load it. It is recommended to load all the keyring files that you have to make sure that you have all the keys loaded. PGPKeyring can detect duplicate keys, so don't worry about loading the same key twice - any duplicates will be neatly merged together into one key object. PGPKeyring keyring = new PGPKeyring(); keyring.ImportFromFile("pubring.pkr"); keyring.ImportFromFile("secring.skr");

You keyring will typically contain two types of keys: public and private. Private keys (i.e. your keys) are used for signing and decryption. Public keys (someone else's keys) are used for encryption and signature verification. This means that if you are looking to decrypt a file, you need to get your private keys ready. If you are looking to verify someone's signature over the data, you need to get the public keys.

When processing protected files PGPReader can look for the required keys in the keyring and select the appropriate ones automatically. This means that you do not need to comb through your key collection manually, cherry-picking public and private keys. Simply assign the entire collection of keys to PGPReader's DecryptingKeys and VerifyingKeys properties, and PGPReader will find and use the right one: reader.DecryptingKeys = keyring.Keys; reader.VerifyingKeys = keyring.Keys;

When it comes to using your private keys - i.e. when decrypting the data - there is one important catch that you need to keep in mind. Private PGP keys are typically protected with passwords. To be able to use them, you need to provide the valid password to the component when the key needs to be used. You can do that in one of the following three ways:

• By assigning the password to property. You can check whether the provided password is valid using the property.
• By assigning the password to KeyPassphrase property. This and the previous method assumes that you anticipate which key you will likely need to use.
• By subscribing to KeyPassphraseNeeded event and providing the password from within the event handler. This event will be fired in the middle of the decryption process for each eligible private key for which no valid password was provided using the first two methods. This method lets you provide the password on-the-fly, and is handy when you don't know which key you are going to use in advance.

Configuring the component

Unprotection configuration if quite straightforward and encompasses adjustment of the following settings:

• Provide the input data via the InputFile (or InputBytes) property.
• Provide the destination in OutputFile. If no output destination is provided, the output will be generated in OutputBytes.
• When processing multi-files PGP archives, consider subscribing to MultipleFilesFound, FileExtractionStart and FileExtractionFinish events. These come handy in tracking progress and adjusting output locations for individual files.
• Depending on your circumstances, you may want to subscribe to Signed and EncryptionInfo events to be notified about various protection parameters.

Unprotecting the file

You are all set now. Call the appropriate unprotection method to proceed with operation:

• DecryptAndVerify: process the input data by decrypting any protected data, extracting individual files, and verifying signatures. This is the method that you would likely need to use in most cases.
• VerifyDetached: verify a detached signature. Remember that you need to provide the original data separately via the DataFile or DataBytes properties.

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.

Armored Property (PGPReader Module)

Indicates if the processed message had been base64-armored.

Syntax

• Swift
• Objective-C

public var armored: Bool {
  get {...}
}

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

- (BOOL)armored;

Default Value

False

Remarks

This property is set to true if the supplied message was armored by encoding it into base64 and adding BEGIN and END brackets.

This property is read-only.

Compressed Property (PGPReader Module)

Indicates if the processed message had been compressed.

Syntax

• Swift
• Objective-C

public var compressed: Bool {
  get {...}
}

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

- (BOOL)compressed;

Default Value

False

Remarks

This property is set to true if the supplied message was compressed by its creator.

This property is read-only.

DataBytes Property (PGPReader Module)

Use this property to pass the original signed data to module in the byte array form.

Syntax

• Swift
• Objective-C

public var dataBytes: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=dataBytes,setter=setDataBytes:) NSData* dataBytes;

- (NSData*)dataBytes;
- (void)setDataBytes :(NSData*)newDataBytes;

Remarks

When validating detached signatures, assign a byte array containing the signed data to this property.

DataFile Property (PGPReader Module)

The name of the file containing the original signed data.

Syntax

• Swift
• Objective-C

public var dataFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=dataFile,setter=setDataFile:) NSString* dataFile;

- (NSString*)dataFile;
- (void)setDataFile :(NSString*)newDataFile;

Default Value

""

Remarks

Use this property to provide the original data when validating detached signatures with VerifyDetached.

DecryptingKeys Property (PGPReader Module)

A collection of keys to be used for decryption.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=decryptingKeyCount,setter=setDecryptingKeyCount:) int decryptingKeyCount;

- (int)decryptingKeyCount;
- (void)setDecryptingKeyCount :(int)newDecryptingKeyCount;

- (long long)decryptingKeyHandle:(int)decryptingKeyIndex;
- (void)setDecryptingKeyHandle:(int)decryptingKeyIndex :(long long)newDecryptingKeyHandle;

- (NSString*)decryptingKeyKeyFP:(int)decryptingKeyIndex;

- (NSString*)decryptingKeyKeyID:(int)decryptingKeyIndex;

- (NSString*)decryptingKeyPassphrase:(int)decryptingKeyIndex;
- (void)setDecryptingKeyPassphrase:(int)decryptingKeyIndex :(NSString*)newDecryptingKeyPassphrase;

- (BOOL)decryptingKeyPassphraseValid:(int)decryptingKeyIndex;

- (NSString*)decryptingKeyUsername:(int)decryptingKeyIndex;

Default Value

0

Remarks

This property is read-only.

ExternalCrypto Property (PGPReader Module)

Provides access to external signing and DC parameters.

Syntax

• Swift
• Objective-C

public var externalCrypto: ExternalCrypto {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=externalCryptoAsyncDocumentID,setter=setExternalCryptoAsyncDocumentID:) NSString* externalCryptoAsyncDocumentID;

- (NSString*)externalCryptoAsyncDocumentID;
- (void)setExternalCryptoAsyncDocumentID :(NSString*)newExternalCryptoAsyncDocumentID;

@property (nonatomic,readwrite,assign,getter=externalCryptoCustomParams,setter=setExternalCryptoCustomParams:) NSString* externalCryptoCustomParams;

- (NSString*)externalCryptoCustomParams;
- (void)setExternalCryptoCustomParams :(NSString*)newExternalCryptoCustomParams;

@property (nonatomic,readwrite,assign,getter=externalCryptoData,setter=setExternalCryptoData:) NSString* externalCryptoData;

- (NSString*)externalCryptoData;
- (void)setExternalCryptoData :(NSString*)newExternalCryptoData;

@property (nonatomic,readwrite,assign,getter=externalCryptoExternalHashCalculation,setter=setExternalCryptoExternalHashCalculation:) BOOL externalCryptoExternalHashCalculation;

- (BOOL)externalCryptoExternalHashCalculation;
- (void)setExternalCryptoExternalHashCalculation :(BOOL)newExternalCryptoExternalHashCalculation;

@property (nonatomic,readwrite,assign,getter=externalCryptoHashAlgorithm,setter=setExternalCryptoHashAlgorithm:) NSString* externalCryptoHashAlgorithm;

- (NSString*)externalCryptoHashAlgorithm;
- (void)setExternalCryptoHashAlgorithm :(NSString*)newExternalCryptoHashAlgorithm;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeyID,setter=setExternalCryptoKeyID:) NSString* externalCryptoKeyID;

- (NSString*)externalCryptoKeyID;
- (void)setExternalCryptoKeyID :(NSString*)newExternalCryptoKeyID;

@property (nonatomic,readwrite,assign,getter=externalCryptoKeySecret,setter=setExternalCryptoKeySecret:) NSString* externalCryptoKeySecret;

- (NSString*)externalCryptoKeySecret;
- (void)setExternalCryptoKeySecret :(NSString*)newExternalCryptoKeySecret;

@property (nonatomic,readwrite,assign,getter=externalCryptoMethod,setter=setExternalCryptoMethod:) int externalCryptoMethod;

- (int)externalCryptoMethod;
- (void)setExternalCryptoMethod :(int)newExternalCryptoMethod;

@property (nonatomic,readwrite,assign,getter=externalCryptoMode,setter=setExternalCryptoMode:) int externalCryptoMode;

- (int)externalCryptoMode;
- (void)setExternalCryptoMode :(int)newExternalCryptoMode;

@property (nonatomic,readwrite,assign,getter=externalCryptoPublicKeyAlgorithm,setter=setExternalCryptoPublicKeyAlgorithm:) NSString* externalCryptoPublicKeyAlgorithm;

- (NSString*)externalCryptoPublicKeyAlgorithm;
- (void)setExternalCryptoPublicKeyAlgorithm :(NSString*)newExternalCryptoPublicKeyAlgorithm;

 

Default Value

0

Remarks

This property is read-only.

FIPSMode Property (PGPReader 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.

InputBytes Property (PGPReader Module)

Use this property to pass the input to module in byte array form.

Syntax

• Swift
• Objective-C

public var inputBytes: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputBytes,setter=setInputBytes:) NSData* inputBytes;

- (NSData*)inputBytes;
- (void)setInputBytes :(NSData*)newInputBytes;

Remarks

Assign a byte array containing the data to be processed to this property.

InputFile Property (PGPReader Module)

Provides a filename of a file to process.

Syntax

• Swift
• Objective-C

public var inputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=inputFile,setter=setInputFile:) NSString* inputFile;

- (NSString*)inputFile;
- (void)setInputFile :(NSString*)newInputFile;

Default Value

""

Remarks

Use this property to provide a path to the file to be encrypted and/or signed.

KeyPassphrase Property (PGPReader Module)

Specifies a passphrase for the decryption key.

Syntax

• Swift
• Objective-C

public var keyPassphrase: String {
  get {...}
  set {...}
}

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

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

Default Value

""

Remarks

Use this property to provide a passphrase for the decryption secret key.

If this property is left empty or a wrong passphrase is provided, the KeyPassphraseNeeded event will be fired to request the correct passphrase.

OutputBytes Property (PGPReader Module)

Use this property to read the output the module object has produced.

Syntax

• Swift
• Objective-C

public var outputBytes: Data {
  get {...}
}

@property (nonatomic,readonly,assign,getter=outputBytes) NSData* outputBytes;

- (NSData*)outputBytes;

Remarks

Read the contents of this property after the operation has completed to read the produced output. This property will only be set if the OutputFile and OutputStream properties had not been assigned.

This property is read-only.

OutputFile Property (PGPReader Module)

The file where the encrypted and/or signed data will be saved.

Syntax

• Swift
• Objective-C

public var outputFile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=outputFile,setter=setOutputFile:) NSString* outputFile;

- (NSString*)outputFile;
- (void)setOutputFile :(NSString*)newOutputFile;

Default Value

""

Remarks

Use this property to provide a path to the file where the class should store the encrypted and/or signed data.

Passphrase Property (PGPReader Module)

Specifies a message decryption password.

Syntax

• Swift
• Objective-C

public var passphrase: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=passphrase,setter=setPassphrase:) NSString* passphrase;

- (NSString*)passphrase;
- (void)setPassphrase :(NSString*)newPassphrase;

Default Value

""

Remarks

Use this property to provide a password to decrypt the data. Whether the message can be decrypted with a password is indicated by PassphraseUsed parameter of EncryptionInfo event.

Note that this is not the same as a secret key passphrase, which should be provided via KeyPassphrase property.

If this property is left empty or the assigned passphrase is incorrect, the PassphraseNeeded event will be fired to request the correct one.

ProcessedLength Property (PGPReader Module)

Reports the number of bytes processed.

Syntax

• Swift
• Objective-C

public var processedLength: Int64 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=processedLength) long long processedLength;

- (long long)processedLength;

Default Value

0

Remarks

Use this property to check the number of bytes that the component has read when processing the protected message.

This property is read-only.

Profile Property (PGPReader Module)

Specifies a pre-defined profile to apply when creating the signature.

Syntax

• Swift
• Objective-C

public var profile: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=profile,setter=setProfile:) NSString* profile;

- (NSString*)profile;
- (void)setProfile :(NSString*)newProfile;

Default Value

""

Remarks

Advanced signatures come in many variants, which are often defined by parties that needs to process them or by local standards. SecureBlackbox profiles are sets of pre-defined configurations which correspond to particular signature variants. By specifying a profile, you are pre-configuring the component to make it produce the signature that matches the configuration corresponding to that profile.

Signatures Property (PGPReader Module)

Contains signatures that were included in the protected message.

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

0

Remarks

This property is read-only.

VerifyingKeys Property (PGPReader Module)

A collection of keys to be used for signature verification.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=verifyingKeyCount,setter=setVerifyingKeyCount:) int verifyingKeyCount;

- (int)verifyingKeyCount;
- (void)setVerifyingKeyCount :(int)newVerifyingKeyCount;

- (long long)verifyingKeyHandle:(int)verifyingKeyIndex;
- (void)setVerifyingKeyHandle:(int)verifyingKeyIndex :(long long)newVerifyingKeyHandle;

- (NSString*)verifyingKeyKeyFP:(int)verifyingKeyIndex;

- (NSString*)verifyingKeyKeyID:(int)verifyingKeyIndex;

- (NSString*)verifyingKeyUsername:(int)verifyingKeyIndex;

Default Value

0

Remarks

This property is read-only.

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

DecryptAndVerify Method (PGPReader Module)

Decrypts and verifies a protected message.

Syntax

• Swift
• Objective-C

public func decryptAndVerify() throws -> Void

- (void)decryptAndVerify;

Remarks

Use this method to unprotect a PGP message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream). The method writes the decrypted message to a byte array (OutputBytes), to a file (OutputFile) or to a stream (OutputStream).

DoAction Method (PGPReader 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;....

Common ActionIDs:

Reset Method (PGPReader Module)

Resets the component settings.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Reset is a generic method available in every class.

VerifyDetached Method (PGPReader Module)

Verifies a detached signature.

Syntax

• Swift
• Objective-C

public func verifyDetached() throws -> Void

- (void)verifyDetached;

Remarks

Use this method to verify a detached signature contained in a byte array (DataBytes), in a file (DataFile) or in a stream (DataStream) over a message contained in a byte array (InputBytes), in a file (InputFile) or in a stream (InputStream).

EncryptionInfo Event (PGPReader Module)

Reports early information on encryption parameters.

Syntax

• Swift
• Objective-C

func onEncryptionInfo(keyIDs: String, encryptedProtection: Int32, passphraseUsed: Bool)

- (void)onEncryptionInfo:(NSString*)keyIDs :(int)encryptedProtection :(BOOL)passphraseUsed;

Remarks

The class fires this event to report early encryption information. Use this event to find out what encryption type is used, and to provide appropriate decryption material (the secret keys or the password) via DecryptingKeys or Passphrase properties.

KeyIDs contains the IDs of the keys that can be used to decrypt the data. PassphraseUsed shows if the message can also be decrypted with a passphrase. Both can be set at the same time, indicating that each of the decryption routes can be taken.

EncryptedProtection parameter specifies whether the message includes a modification detection record.

Error Event (PGPReader Module)

Information about errors during PGP decryption/verification.

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 decryption/verification of protected data.

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

ExternalDecrypt Event (PGPReader Module)

Handles remote or external decryption.

Syntax

• Swift
• Objective-C

func onExternalDecrypt(operationId: String, algorithm: String, pars: String, encryptedData: String, data: inout String)

- (void)onExternalDecrypt:(NSString*)operationId :(NSString*)algorithm :(NSString*)pars :(NSString*)encryptedData :(NSString**)data;

Remarks

Assign a handler to this event if you need to delegate a low-level decryption operation to an external, remote, or custom decryption engine. The handler receives an encrypted value in the EncryptedData parameter, and is expected to decrypt it and place the decrypted value into the Data parameter.

OperationId provides a comment about the operation and its origin. It depends on the exact class being used, and may be empty. Algorithm specifies the encryption algorithm being used, and Pars contains algorithm-dependent parameters.

The class uses base16 (hex) encoding for the EncryptedData, Data, and Pars parameters. If your decryption engine uses a different input and output encoding, you may need to decode and/or encode the data before and/or after the decryption.

Sample data encoded in base16: a0dee2a0382afbb09120ffa7ccd8a152 - lower case base16 A0DEE2A0382AFBB09120FFA7CCD8A152 - upper case base16

FileExtractionFinish Event (PGPReader Module)

Reports the ending of file extraction process.

Syntax

• Swift
• Objective-C

func onFileExtractionFinish(fileName: String, timestamp: String)

- (void)onFileExtractionFinish:(NSString*)fileName :(NSString*)timestamp;

Remarks

This event informs about the ending of extraction of the next available file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

In the handler, the user can take away the output stream or store the file data from OutputBytes.

FileExtractionStart Event (PGPReader Module)

Reports the beginning of file extraction process.

Syntax

• Swift
• Objective-C

func onFileExtractionStart(fileName: String, timestamp: String, skip: inout Bool)

- (void)onFileExtractionStart:(NSString*)fileName :(NSString*)timestamp :(int*)skip;

Remarks

This event informs about the beginning of extraction of the next available file. A PGP message may contain more than one file. FileName parameter indicates the original file name, and the Timestamp its last modification time.

The user should provide an output filename in OutputFile or a stream in OutputStream. If none of them is provided, the extracted file will be placed to OutputBytes. After the file is extracted, FileExtractionFinish event is fired.

KeyPassphraseNeeded Event (PGPReader 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 (which is requested via PassphraseNeeded). The class fires it when it has found a suitable decryption secret key in the keyring, and attempts to use it to decrypt the data.

If the data is encrypted with multiple keys, this event is called for each key in a loop until the password for at least one key is provided correctly. 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.

MultipleFilesFound Event (PGPReader Module)

Fires if the PGP message is recognized to contain multiple files.

Syntax

• Swift
• Objective-C

func onMultipleFilesFound(tarFileName: String, proceed: inout Bool)

- (void)onMultipleFilesFound:(NSString*)tarFileName :(int*)proceed;

Remarks

The class fires this event to report that there is more than one file in the PGP message.

The TarFileName specifies the name of the TAR file containing the files. Tune up Proceed to go ahead or stop the processing.

Notification Event (PGPReader 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.

PassphraseNeeded Event (PGPReader Module)

Requests a data protection password from the application.

Syntax

• Swift
• Objective-C

func onPassphraseNeeded(passphrase: inout String, skip: inout Bool)

- (void)onPassphraseNeeded:(NSString**)passphrase :(int*)skip;

Remarks

The class fires this event to request a decryption password. It is only fired if the data can be decrypted without a key.

The event is fired in a loop until the correct password is passed or the number of password attempts is exceeded.

Progress Event (PGPReader Module)

Reports the progress of the decryption operation.

Syntax

• Swift
• Objective-C

func onProgress(current: Int64, total: Int64, cancel: inout Bool)

- (void)onProgress:(long long)current :(long long)total :(int*)cancel;

Remarks

The class fires this event repeatedly to report the progress of the file extraction operation.

Current indicates the amount of processed data in bytes, and Total is the total number of bytes to be processed. Use Cancel to terminate the extraction process.

Signed Event (PGPReader Module)

Notifies the application about a signed message.

Syntax

• Swift
• Objective-C

func onSigned(keyIDs: String, signatureType: Int32)

- (void)onSigned:(NSString*)keyIDs :(int)signatureType;

Remarks

The class fires this event when it identifies a signed message to allow the application to prepare the component for verification.

Use the KeyIDs parameter to identify keys used that were used to sign the message, and make sure they are available in the VerifyingKeys list.

SignatureType indicates the signature type:

ExternalCrypto Type

Specifies the parameters of external cryptographic calls.

Remarks

External cryptocalls are used in a Distributed Cryptography (DC) subsystem, which allows the delegation of security operations to the remote agent. For instance, it can be used to compute the signature value on the server, while retaining the client's private key locally.

Fields

Constructors

public init()

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

Config Settings (PGPReader Module)

PGPReader Config Settings

Base Config Settings

Trappable Errors (PGPReader Module)

PGPReader Errors