PGPReader Module

Properties   Methods   Events   Config Settings   Errors  

The PGPReader module reads and unprotects protected PGP files.

Syntax

SecureBlackbox.Pgpreader

Remarks

PGPReader allows you to parse PGP messages and manipulate PGP-secured data. It decrypts the protected data, decompresses it, verifies signatures, and returns "clear" data.

Property List


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

ArmoredIndicates if the processed message had been base64-armored.
CompressedIndicates if the processed message had been compressed.
DataBytesUse this property to pass the original signed data to module in the byte array form.
DataFileThe name of the file containing the original signed data.
DecryptingKeysA collection of keys to be used for decryption.
ExternalCryptoProvides access to external signing and DC parameters.
FIPSModeReserved.
InputBytesUse this property to pass the input to module in byte array form.
InputFileProvides a filename of a file to process.
KeyPassphraseSpecifies a passphrase for the decryption key.
OutputBytesUse this property to read the output the module object has produced.
OutputFileThe file where the encrypted and/or signed data will be saved.
PassphraseSpecifies a message decryption password.
ProcessedLengthReports the number of bytes processed.
ProfileSpecifies a pre-defined profile to apply when creating the signature.
SignaturesContains signatures that were included in the protected message.
VerifyingKeysA collection of keys to be used for signature verification.

Method List


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

ConfigSets or retrieves a configuration setting.
DecryptAndVerifyDecrypts and verifies a protected message.
DoActionPerforms an additional action.
VerifyDetachedVerifies a detached signature.

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.

EncryptionInfoReports early information on encryption parameters.
ErrorInformation about errors during PGP decryption/verification.
ExternalDecryptHandles remote or external decryption.
FileExtractionFinishReports the ending of file extraction process.
FileExtractionStartReports the beginning of file extraction process.
KeyPassphraseNeededRequests a key protection password from the application.
MultipleFilesFoundFires if the PGP message is recognized to contain multiple files.
NotificationThis event notifies the application about an underlying control flow event.
PassphraseNeededRequests a data protection password from the application.
ProgressReports the progress of the decryption operation.
SignedNotifies the application about a signed message.

Config Settings


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

IgnoreDataPacketLengthsWhether to check the length of input data packets.
PasswordAttemptsThe number of attempts allowed for entering password.
TempPathPath for storing temporary files.
UndefInputLengthSet this property if you are working with non-seekable streams.
UseGreedyMemoryConsumptionWhether to limit memory consumption for the cost of speed.
CheckKeyIntegrityBeforeUseEnables or disable private key integrity check before use.
CookieCachingSpecifies whether a cookie cache should be used for HTTP(S) transports.
CookiesGets or sets local cookies for the module.
DefDeriveKeyIterationsSpecifies the default key derivation algorithm iteration count.
EnableClientSideSSLFFDHEEnables or disables finite field DHE key exchange support in TLS clients.
GlobalCookiesGets or sets global cookies for all the HTTP transports.
HttpUserAgentSpecifies the user agent name to be used by all HTTP clients.
LogDestinationSpecifies the debug log destination.
LogDetailsSpecifies the debug log details to dump.
LogFileSpecifies the debug log filename.
LogFiltersSpecifies the debug log filters.
LogFlushModeSpecifies the log flush mode.
LogLevelSpecifies the debug log level.
LogMaxEventCountSpecifies the maximum number of events to cache before further action is taken.
LogRotationModeSpecifies the log rotation mode.
MaxASN1BufferLengthSpecifies the maximal allowed length for ASN.1 primitive tag data.
MaxASN1TreeDepthSpecifies the maximal depth for processed ASN.1 trees.
OCSPHashAlgorithmSpecifies the hash algorithm to be used to identify certificates in OCSP requests.
StaticDNSSpecifies whether static DNS rules should be used.
StaticIPAddress[domain]Gets or sets an IP address for the specified domain name.
StaticIPAddressesGets or sets all the static DNS rules.
TagAllows to store any custom data.
TLSSessionGroupSpecifies the group name of TLS sessions to be used for session resumption.
TLSSessionLifetimeSpecifies lifetime in seconds of the cached TLS session.
TLSSessionPurgeIntervalSpecifies how often the session cache should remove the expired TLS sessions.
UseOwnDNSResolverSpecifies whether the client modules should use own DNS resolver.
UseSharedSystemStoragesSpecifies whether the validation engine should use a global per-process copy of the system certificate stores.
UseSystemOAEPAndPSSEnforces or disables the use of system-driven RSA OAEP and PSS computations.
UseSystemRandomEnables or disables the use of the OS PRNG.

Armored Property (PGPReader Module)

Indicates if the processed message had been base64-armored.

Syntax

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

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

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

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

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;
- (void)setDecryptingKeyUsername:(int)decryptingKeyIndex :(NSString*)newDecryptingKeyUsername;

Default Value

-1

Remarks

This property is read-only.

ExternalCrypto Property (PGPReader Module)

Provides access to external signing and DC parameters.

Syntax

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

-1

Remarks

This property is read-only.

FIPSMode Property (PGPReader Module)

Reserved.

Syntax

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

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

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

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

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

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

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

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

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

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)signatureKeyExpirationTime:(int)signatureIndex;

- (BOOL)signatureLegacyFormat:(int)signatureIndex;

- (NSString*)signaturePolicyURL:(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;

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

-1

Remarks

This property is read-only.

VerifyingKeys Property (PGPReader Module)

A collection of keys to be used for signature verification.

Syntax

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;
- (void)setVerifyingKeyUsername:(int)verifyingKeyIndex :(NSString*)newVerifyingKeyUsername;

Default Value

-1

Remarks

This property is read-only.

Config Method (PGPReader Module)

Sets or retrieves a configuration setting.

Syntax

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

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

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;....

VerifyDetached Method (PGPReader Module)

Verifies a detached signature.

Syntax

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

func onEncryptionInfo(keyIDs: String, integrityProtected: Bool, passphraseUsed: Bool)
- (void)onEncryptionInfo:(NSString*)keyIDs :(BOOL)integrityProtected :(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.

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

Error Event (PGPReader Module)

Information about errors during PGP decryption/verification.

Syntax

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

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

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

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

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

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

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

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

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

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:

pstNormal0A traditional signature, compatible (algorithm permitting) with PGP 2.6.x

pstOnePass1A newer one-pass signature

pstDetached2A detached signature, i.e., a signature contained in a separate file from the data it covers

pstCleartext3A signature made over textual data and appended to it

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

asyncDocumentID
String

Default Value: ""

Specifies an optional document ID for SignAsyncBegin() and SignAsyncEnd() calls.

Use this property when working with multi-signature DCAuth requests and responses to uniquely identify documents signed within a larger batch. On the completion stage, this value helps the signing component identify the correct signature in the returned batch of responses.

If using batched requests, make sure to set this property to the same value on both the pre-signing (SignAsyncBegin) and completion (SignAsyncEnd) stages.

customParams
String

Default Value: ""

Custom parameters to be passed to the signing service (uninterpreted).

data
String

Default Value: ""

Additional data to be included in the async state and mirrored back by the requestor.

externalHashCalculation
Bool

Default Value: False

Specifies whether the message hash is to be calculated at the external endpoint. Please note that this mode is not supported by the DCAuth class.

If set to true, the class will pass a few kilobytes of to-be-signed data from the document to the OnExternalSign event. This only applies when SignExternal() is called.

hashAlgorithm
String

Default Value: "SHA256"

Specifies the request's signature hash algorithm.

SB_HASH_ALGORITHM_SHA1SHA1
SB_HASH_ALGORITHM_SHA224SHA224
SB_HASH_ALGORITHM_SHA256SHA256
SB_HASH_ALGORITHM_SHA384SHA384
SB_HASH_ALGORITHM_SHA512SHA512
SB_HASH_ALGORITHM_MD2MD2
SB_HASH_ALGORITHM_MD4MD4
SB_HASH_ALGORITHM_MD5MD5
SB_HASH_ALGORITHM_RIPEMD160RIPEMD160
SB_HASH_ALGORITHM_CRC32CRC32
SB_HASH_ALGORITHM_SSL3SSL3
SB_HASH_ALGORITHM_GOST_R3411_1994GOST1994
SB_HASH_ALGORITHM_WHIRLPOOLWHIRLPOOL
SB_HASH_ALGORITHM_POLY1305POLY1305
SB_HASH_ALGORITHM_SHA3_224SHA3_224
SB_HASH_ALGORITHM_SHA3_256SHA3_256
SB_HASH_ALGORITHM_SHA3_384SHA3_384
SB_HASH_ALGORITHM_SHA3_512SHA3_512
SB_HASH_ALGORITHM_BLAKE2S_128BLAKE2S_128
SB_HASH_ALGORITHM_BLAKE2S_160BLAKE2S_160
SB_HASH_ALGORITHM_BLAKE2S_224BLAKE2S_224
SB_HASH_ALGORITHM_BLAKE2S_256BLAKE2S_256
SB_HASH_ALGORITHM_BLAKE2B_160BLAKE2B_160
SB_HASH_ALGORITHM_BLAKE2B_256BLAKE2B_256
SB_HASH_ALGORITHM_BLAKE2B_384BLAKE2B_384
SB_HASH_ALGORITHM_BLAKE2B_512BLAKE2B_512
SB_HASH_ALGORITHM_SHAKE_128SHAKE_128
SB_HASH_ALGORITHM_SHAKE_256SHAKE_256
SB_HASH_ALGORITHM_SHAKE_128_LENSHAKE_128_LEN
SB_HASH_ALGORITHM_SHAKE_256_LENSHAKE_256_LEN

keyID
String

Default Value: ""

The ID of the pre-shared key used for DC request authentication.

Asynchronous DCAuth-driven communication requires that parties authenticate each other with a secret pre-shared cryptographic key. This provides an extra protection layer for the protocol and diminishes the risk of the private key becoming abused by foreign parties. Use this property to provide the pre-shared key identifier, and use to pass the key itself.

The same KeyID/KeySecret pair should be used on the DCAuth side for the signing requests to be accepted.

Note: The KeyID/KeySecret scheme is very similar to the AuthKey scheme used in various Cloud service providers to authenticate users.

Example: signer.ExternalCrypto.KeyID = "MainSigningKey"; signer.ExternalCrypto.KeySecret = "abcdef0123456789";

keySecret
String

Default Value: ""

The pre-shared key used for DC request authentication. This key must be set and match the key used by the DCAuth counterpart for the scheme to work.

Read more about configuring authentication in the topic.

method
AsyncSignMethods

Default Value: 0

Specifies the asynchronous signing method. This is typically defined by the DC server capabilities and setup.

Available options:

asmdPKCS10
asmdPKCS71

mode
ExternalCryptoModes

Default Value: 0

Specifies the external cryptography mode.

Available options:

ecmDefaultThe default value (0)
ecmDisabledDo not use DC or external signing (1)
ecmGenericGeneric external signing with the OnExternalSign event (2)
ecmDCAuthDCAuth signing (3)
ecmDCAuthJSONDCAuth signing in JSON format (4)

publicKeyAlgorithm
String

Default Value: ""

Provide the public key algorithm here if the certificate is not available on the pre-signing stage.

SB_CERT_ALGORITHM_ID_RSA_ENCRYPTIONrsaEncryption
SB_CERT_ALGORITHM_MD2_RSA_ENCRYPTIONmd2withRSAEncryption
SB_CERT_ALGORITHM_MD5_RSA_ENCRYPTIONmd5withRSAEncryption
SB_CERT_ALGORITHM_SHA1_RSA_ENCRYPTIONsha1withRSAEncryption
SB_CERT_ALGORITHM_ID_DSAid-dsa
SB_CERT_ALGORITHM_ID_DSA_SHA1id-dsa-with-sha1
SB_CERT_ALGORITHM_DH_PUBLICdhpublicnumber
SB_CERT_ALGORITHM_SHA224_RSA_ENCRYPTIONsha224WithRSAEncryption
SB_CERT_ALGORITHM_SHA256_RSA_ENCRYPTIONsha256WithRSAEncryption
SB_CERT_ALGORITHM_SHA384_RSA_ENCRYPTIONsha384WithRSAEncryption
SB_CERT_ALGORITHM_SHA512_RSA_ENCRYPTIONsha512WithRSAEncryption
SB_CERT_ALGORITHM_ID_RSAPSSid-RSASSA-PSS
SB_CERT_ALGORITHM_ID_RSAOAEPid-RSAES-OAEP
SB_CERT_ALGORITHM_RSASIGNATURE_RIPEMD160ripemd160withRSA
SB_CERT_ALGORITHM_ID_ELGAMALelGamal
SB_CERT_ALGORITHM_SHA1_ECDSAecdsa-with-SHA1
SB_CERT_ALGORITHM_RECOMMENDED_ECDSAecdsa-recommended
SB_CERT_ALGORITHM_SHA224_ECDSAecdsa-with-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSAecdsa-with-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSAecdsa-with-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSAecdsa-with-SHA512
SB_CERT_ALGORITHM_ECid-ecPublicKey
SB_CERT_ALGORITHM_SPECIFIED_ECDSAecdsa-specified
SB_CERT_ALGORITHM_GOST_R3410_1994id-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3410_2001id-GostR3410-2001
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_1994id-GostR3411-94-with-GostR3410-94
SB_CERT_ALGORITHM_GOST_R3411_WITH_R3410_2001id-GostR3411-94-with-GostR3410-2001
SB_CERT_ALGORITHM_SHA1_ECDSA_PLAINecdsa-plain-SHA1
SB_CERT_ALGORITHM_SHA224_ECDSA_PLAINecdsa-plain-SHA224
SB_CERT_ALGORITHM_SHA256_ECDSA_PLAINecdsa-plain-SHA256
SB_CERT_ALGORITHM_SHA384_ECDSA_PLAINecdsa-plain-SHA384
SB_CERT_ALGORITHM_SHA512_ECDSA_PLAINecdsa-plain-SHA512
SB_CERT_ALGORITHM_RIPEMD160_ECDSA_PLAINecdsa-plain-RIPEMD160
SB_CERT_ALGORITHM_WHIRLPOOL_RSA_ENCRYPTIONwhirlpoolWithRSAEncryption
SB_CERT_ALGORITHM_ID_DSA_SHA224id-dsa-with-sha224
SB_CERT_ALGORITHM_ID_DSA_SHA256id-dsa-with-sha256
SB_CERT_ALGORITHM_SHA3_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSAid-ecdsa-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSAid-ecdsa-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSAid-ecdsa-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSAid-ecdsa-with-sha3-512
SB_CERT_ALGORITHM_SHA3_224_ECDSA_PLAINid-ecdsa-plain-with-sha3-224
SB_CERT_ALGORITHM_SHA3_256_ECDSA_PLAINid-ecdsa-plain-with-sha3-256
SB_CERT_ALGORITHM_SHA3_384_ECDSA_PLAINid-ecdsa-plain-with-sha3-384
SB_CERT_ALGORITHM_SHA3_512_ECDSA_PLAINid-ecdsa-plain-with-sha3-512
SB_CERT_ALGORITHM_ID_DSA_SHA3_224id-dsa-with-sha3-224
SB_CERT_ALGORITHM_ID_DSA_SHA3_256id-dsa-with-sha3-256
SB_CERT_ALGORITHM_BLAKE2S_128_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_RSA_ENCRYPTIONid-rsassa-pkcs1-v1_5-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSAid-ecdsa-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSAid-ecdsa-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSAid-ecdsa-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSAid-ecdsa-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSAid-ecdsa-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSAid-ecdsa-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSAid-ecdsa-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSAid-ecdsa-with-blake2b512
SB_CERT_ALGORITHM_BLAKE2S_128_ECDSA_PLAINid-ecdsa-plain-with-blake2s128
SB_CERT_ALGORITHM_BLAKE2S_160_ECDSA_PLAINid-ecdsa-plain-with-blake2s160
SB_CERT_ALGORITHM_BLAKE2S_224_ECDSA_PLAINid-ecdsa-plain-with-blake2s224
SB_CERT_ALGORITHM_BLAKE2S_256_ECDSA_PLAINid-ecdsa-plain-with-blake2s256
SB_CERT_ALGORITHM_BLAKE2B_160_ECDSA_PLAINid-ecdsa-plain-with-blake2b160
SB_CERT_ALGORITHM_BLAKE2B_256_ECDSA_PLAINid-ecdsa-plain-with-blake2b256
SB_CERT_ALGORITHM_BLAKE2B_384_ECDSA_PLAINid-ecdsa-plain-with-blake2b384
SB_CERT_ALGORITHM_BLAKE2B_512_ECDSA_PLAINid-ecdsa-plain-with-blake2b512
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_224id-dsa-with-blake2s224
SB_CERT_ALGORITHM_ID_DSA_BLAKE2S_256id-dsa-with-blake2s256
SB_CERT_ALGORITHM_EDDSA_ED25519id-Ed25519
SB_CERT_ALGORITHM_EDDSA_ED448id-Ed448
SB_CERT_ALGORITHM_EDDSA_ED25519_PHid-Ed25519ph
SB_CERT_ALGORITHM_EDDSA_ED448_PHid-Ed448ph
SB_CERT_ALGORITHM_EDDSAid-EdDSA
SB_CERT_ALGORITHM_EDDSA_SIGNATUREid-EdDSA-sig

Constructors

public init()

Creates a new ExternalCrypto object with default field values.

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

bitsInKey
Int32

Default Value: 2048

Indicates the key length in bits.

canEncrypt
Bool (read-only)

Default Value: False

Returns True if this key can be used for encryption.

canSign
Bool (read-only)

Default Value: False

Returns True if this key can be used for signing.

curve
String

Default Value: ""

Indicates the elliptic curve associated with a EC key.

Supported values:

SB_PGP_CURVE_P256P256
SB_PGP_CURVE_P384P384
SB_PGP_CURVE_P521P521
SB_PGP_CURVE_ED25519ED25519
SB_PGP_CURVE_CURVE25519CURVE25519
SB_PGP_CURVE_BRAINPOOLP256R1BRAINPOOLP256
SB_PGP_CURVE_BRAINPOOLP512R1BRAINPOOLP512

enabled
Bool

Default Value: False

Enables or disables this key for use in encryption or signing operation.

encryptionAlgorithm
String

Default Value: "CAST5"

Indicates the symmetric algorithm used to encrypt the secret key.

expires
Int32

Default Value: 0

Indicates key expiration time in whole days from its generation moment. The value of 0 indicates that the key does not expire.

handle
Int64

Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

hashAlgorithm
String

Default Value: "SHA256"

Specifies the hash algorithm associated with the key.

isPublic
Bool (read-only)

Default Value: False

Returns True if this key is a public key, and False otherwise.

isSecret
Bool (read-only)

Default Value: False

Returns True if this key is a secret key, and False otherwise.

isSubkey
Bool (read-only)

Default Value: False

Returns True if this key is a subkey of another key, and False otherwise.

keyFP
String (read-only)

Default Value: ""

The 20-byte fingerprint (hash value) of this key.

KeyFP could be used to distinguish two keys with the same KeyID.

keyHashAlgorithm
String (read-only)

Default Value: "SHA256"

Specifies the hash algorithm used with DSA keys to calculate signatures.

keyID
String (read-only)

Default Value: ""

Contains a 8-byte key identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (KeyFP) can be used for distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

oldPacketFormat
Bool

Default Value: False

Indicates whether legacy (PGP 2.6.x) packet format should be used.

passphrase
String

Default Value: ""

The key protection password.

passphraseValid
Bool (read-only)

Default Value: False

Use this property to check whether the specified is valid and can be used to unlock the secret key.

primaryKeyID
String (read-only)

Default Value: ""

If this key is a subkey ( returns True), this property contains the identifier of the subkey's primary key.

protection
PGPProtectionTypes

Default Value: 0

Specifies the level of protection applied to the secret key.

Allowed values:

pptNone0Key is not encrypted
pptLow1Only the password hash is used to derive the secret key
pptNormal2Password hash with salt is used to derive the secret key
pptHigh3Hash from multiple passwords and salt are used for key derivation

publicKeyAlgorithm
String

Default Value: ""

Specifies the asymmetric algorithm of the key.

qBits
Int32

Default Value: 0

The length of the DSA Q (legitimate range: 160-512).

This parameter corresponds to the hash algorithm used with the key. For example, if the value of Q is 256, SHA-256 will be used.

revoked
Bool (read-only)

Default Value: False

Returns True if the key has been revoked, and False otherwise.

subkeyFP
String (read-only)

Default Value: ""

The 20-byte fingerprint (hash value) of this key's subkey.

KeyFP could be used to distinguish two subkeys with the same SubkeyID.

subkeyID
String (read-only)

Default Value: ""

Contains a 8-byte subkey identifier.

It is quite rare that IDs of two keys collide. If that happens, their fingerprints (SubkeyFP) can be used to distinguish between the keys. Please note that many PGP implementations show only 4 lowest bytes of the KeyID to the user.

timestamp
String (read-only)

Default Value: ""

Use this property to check the time the key was generated. The date and time are stored and retrieved in Universal Coordinate Time (UTC).

username
String

Default Value: ""

Specifies the name of the user bound to this key.

The PGP username is typically represented with a full name and an email address, but generally can be any non-empty string.

valid
PGPKeyValidities (read-only)

Default Value: 0

Indicates the validity status of the key.

pkvStrictlyValid0Strictly valid

pkvValid1Valid

pkvInvalid2Invalid

pkvFailure3Generic validation failure

pkvUnknown4Validity unknown

validTo
String (read-only)

Default Value: "0"

Provide accurate expiration moment indication. This is different to property which only contains expiration time in days in old keys.

version
Int32 (read-only)

Default Value: -1

Indicates the key version.

The key version refers to the version of the public-key packet format as defined in RFC 4880.

Only two versions are currently allowed here: 3 and 4. It is recommended that all new keys are created with version of 4.

Constructors

public init()

Creates an empty PGP key object.

PGPSignature Type

A container for PGP signature properties.

Remarks

PGPSignature contains details and validation information for a PGP signature.

Fields

certificationType
PGPCertificationTypes (read-only)

Default Value: 0

Specifies the type of a UserID signature.

pctGeneric0Generic certification of a User ID and Public Key packet. The issuer of this certification does not make any particular assertion as to how well the certifier has checked that the owner of the key is in fact the person described by the User ID. By default user certifications use Generic type.
pctPersona1Persona certification of a User ID and Public Key packet. The issuer of this certification has not done any verification of the claim that the owner of this key corresponds to the specified User ID.
pctCasual2Casual certification of a User ID and a Public Key packet. The issuer of this certification has done some casual verification of the claim of identity.
pctPositive3Positive certification of a User ID and a Public Key packet. The issuer of this certification has done substantial verification of the claim of identity.

creationTime
String (read-only)

Default Value: ""

The time when the signature was created, in Universal Coordinated Time (UTC).

expirationTime
Int32 (read-only)

Default Value: 0

Specifies signature expiration time, in seconds since its creation time (CreationTime).

Ths property set to 0 indicates that the signature never expires.

exportable
Bool (read-only)

Default Value: False

Specifies whether a certification signature is "exportable", meaning it can be used by entities other than the signature's issuer.

handle
Int64

Default Value: 0

Allows to get or set a 'handle', a unique identifier of the underlying property object. Use this property to assign objects of the same type in a quicker manner, without copying them fieldwise.

When you pass a handle of one object to another, the source object is copied to the destination rather than assigned. It is safe to get rid of the original object after such operation. pdfSigner.setSigningCertHandle(certMgr.getCertHandle());

hashAlgorithm
String (read-only)

Default Value: ""

Specifies the hash algorithm used in the signature.

keyExpirationTime
Int32 (read-only)

Default Value: 0

The number of seconds after which the signed key will expire.

legacyFormat
Bool (read-only)

Default Value: False

Indicates whether signature uses PGP 2.6.x-compatible packet format.

The signature is fully compatible with the 'old' format only if it has version 3, uses MD5 hash algorithm, RSA public key algorithm, and its key length is not greater than 1024 bits.

policyURL
String (read-only)

Default Value: ""

Contains the URL of the signature policy.

primaryUserID
Bool (read-only)

Default Value: False

Indicates whether the UserID covered by the signature is the main user id for this key.

reasonForRevocation
String (read-only)

Default Value: ""

Describes the reason why the key or the certificate was revoked.

revocable
Bool (read-only)

Default Value: False

Specifies whether the signature can be revoked.

revocation
Bool (read-only)

Default Value: False

Indicates whether or not the signature is a revocation signature.

signatureClass
PGPSignatureClasses (read-only)

Default Value: 0

Indicates the signature class.

pscDocument0Signature over binary file
pscTextDocument1Signature over text
pscStandalone2A standalone signature
pscUIDGeneric3User certification signature
pscUIDPersona4User certification signature (persona)
pscUIDCasual5User certification signature (casual)
pscUIDPositive6User certification signature (positive)
pscSubkeyBinding7Subkey binding signature
pscPublicKeyBinding8Public key binding signature
pscDirectKey9Direct signature over a public key
pscKeyRevocation10Key revocation
pscSubkeyRevocation11Subkey revocation
pscCertRevocation12User revocation
pscTimestamp13Timestamp signature
pscThirdParty14Third-party signature
pscNotSpecified15Signature type not provided

signerKeyID
String (read-only)

Default Value: ""

Indicates the KeyID of the signing key.

signerUserID
String (read-only)

Default Value: ""

Indicates the UserID associated with the signing key.

strictlyValid
Bool (read-only)

Default Value: False

Returns True if this signature is valid in a strict way (no compatibility relaxations).

textSignature
Bool (read-only)

Default Value: False

Indicates whether or not the signature is made over a text document.

trustAmount
Int32 (read-only)

Default Value: 0

Specifies the amount of trust assigned by this signature.

Specifies the amount of trust, in range 0-255, interpreted such that values less than 120 indicate partial trust and values of 120 or greater indicate complete trust.

trustLevel
Int32 (read-only)

Default Value: 0

The trust level assigned by this signature.

Level 1 means that the signed key is asserted to be a valid trusted introducer, with the 2nd octet of the body specifying the degree of trust. Level n means that the signed key is asserted to be trusted to issue level (n-1)-trust signatures.

validated
Bool (read-only)

Default Value: False

Whether the signature has been validated.

validity
PGPSignatureValidities (read-only)

Default Value: 0

Provides the validity status of the signature if the signature has been validated.

psvValid0Valid
psvCorrupted1Corrupted
psvUnknownAlgorithm2Unknown signature algorithm
psvNoKey3Signing key not found, cannot verify
psvUnknown4"Unknown

version
Int32 (read-only)

Default Value: 0

Indicates the signature version.

RFC 4880 defines two versions for PGP signatures: 3 and 4.

Constructors

public init()

Creates an empty PGPSignature object.

Config Settings (PGPReader Module)

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.

PGPReader Config Settings

IgnoreDataPacketLengths:   Whether to check the length of input data packets.

Set this property to True to prevent the class from checking input packet lengths.

PasswordAttempts:   The number of attempts allowed for entering password.

Use this property to specify how many times a wrong password may be entered.

TempPath:   Path for storing temporary files.

This setting specifies an absolute path to the location on disk where temporary files are stored.

UndefInputLength:   Set this property if you are working with non-seekable streams.

Use this property to turn on support for streams with unknown length and position parameters, such as network or database streams. It prevents the class from checking input stream length or position.

UseGreedyMemoryConsumption:   Whether to limit memory consumption for the cost of speed.

When this property is True, the class uses more memory, but decrypts data faster. Otherwise, less memory is consumed, but the decryption is slower.

Base Config Settings

CheckKeyIntegrityBeforeUse:   Enables or disable private key integrity check before use.

This global property enables or disables private key material check before each signing operation. This slows down performance a bit, but prevents a selection of attacks on RSA keys where keys with unknown origins are used.

You can switch this property off to improve performance if your project only uses known, good private keys.

CookieCaching:   Specifies whether a cookie cache should be used for HTTP(S) transports.

Set this property to enable or disable cookies caching for the class.

Supported values are:

offNo caching (default)
localLocal caching
globalGlobal caching

Cookies:   Gets or sets local cookies for the class.

Use this property to get cookies from the internal cookie storage of the class and/or restore them back between application sessions.

DefDeriveKeyIterations:   Specifies the default key derivation algorithm iteration count.

This global property sets the default number of iterations for all supported key derivation algorithms. Note that you can provide the required number of iterations by using properties of the relevant key generation component; this global setting is used in scenarios where specific iteration count is not or cannot be provided.

EnableClientSideSSLFFDHE:   Enables or disables finite field DHE key exchange support in TLS clients.

This global property enables or disables support for finite field DHE key exchange methods in TLS clients. FF DHE is a slower algorithm if compared to EC DHE; enabling it may result in slower connections.

This setting only applies to sessions negotiated with TLS version 1.3.

GlobalCookies:   Gets or sets global cookies for all the HTTP transports.

Use this property to get cookies from the GLOBAL cookie storage or restore them back between application sessions. These cookies will be used by all the classes that have its CookieCaching property set to "global".

HttpUserAgent:   Specifies the user agent name to be used by all HTTP clients.

This global setting defines the User-Agent field of the HTTP request provides information about the software that initiates the request. This value will be used by all the HTTP clients including the ones used internally in other classes.

LogDestination:   Specifies the debug log destination.

Contains a comma-separated list of values that specifies where debug log should be dumped.

Supported values are:

fileFile
consoleConsole
systemlogSystem Log (supported for Android only)
debuggerDebugger (supported for VCL for Windows and .Net)

LogDetails:   Specifies the debug log details to dump.

Contains a comma-separated list of values that specifies which debug log details to dump.

Supported values are:

timeCurrent time
levelLevel
packagePackage name
moduleModule name
classClass name
methodMethod name
threadidThread Id
contenttypeContent type
contentContent
allAll details

LogFile:   Specifies the debug log filename.

Use this property to provide a path to the log file.

LogFilters:   Specifies the debug log filters.

Contains a comma-separated list of value pairs ("name:value") that describe filters.

Supported filter names are:

exclude-packageExclude a package specified in the value
exclude-moduleExclude a module specified in the value
exclude-classExclude a class specified in the value
exclude-methodExclude a method specified in the value
include-packageInclude a package specified in the value
include-moduleInclude a module specified in the value
include-classInclude a class specified in the value
include-methodInclude a method specified in the value

LogFlushMode:   Specifies the log flush mode.

Use this property to set the log flush mode. The following values are defined:

noneNo flush (caching only)
immediateImmediate flush (real-time logging)
maxcountFlush cached entries upon reaching LogMaxEventCount entries in the cache.

LogLevel:   Specifies the debug log level.

Use this property to provide the desired debug log level.

Supported values are:

noneNone (by default)
fatalSevere errors that cause premature termination.
errorOther runtime errors or unexpected conditions.
warningUse of deprecated APIs, poor use of API, 'almost' errors, other runtime situations that are undesirable or unexpected, but not necessarily "wrong".
infoInteresting runtime events (startup/shutdown).
debugDetailed information on flow of through the system.
traceMore detailed information.

LogMaxEventCount:   Specifies the maximum number of events to cache before further action is taken.

Use this property to specify the log event number threshold. This threshold may have different effects, depending on the rotation setting and/or the flush mode.

The default value of this setting is 100.

LogRotationMode:   Specifies the log rotation mode.

Use this property to set the log rotation mode. The following values are defined:

noneNo rotation
deleteolderDelete older entries from the cache upon reaching LogMaxEventCount
keepolderKeep older entries in the cache upon reaching LogMaxEventCount (newer entries are discarded)

MaxASN1BufferLength:   Specifies the maximal allowed length for ASN.1 primitive tag data.

This global property limits the maximal allowed length for ASN.1 tag data for non-content-carrying structures, such as certificates, CRLs, or timestamps. It does not affect structures that can carry content, such as CMS/CAdES messages. This is a security property aiming at preventing DoS attacks.

MaxASN1TreeDepth:   Specifies the maximal depth for processed ASN.1 trees.

This global property limits the maximal depth of ASN.1 trees that the component can handle without throwing an error. This is a security property aiming at preventing DoS attacks.

OCSPHashAlgorithm:   Specifies the hash algorithm to be used to identify certificates in OCSP requests.

This global setting defines the hash algorithm to use in OCSP requests during chain validation. Some OCSP responders can only use older algorithms, in which case setting this property to SHA1 may be helpful.

StaticDNS:   Specifies whether static DNS rules should be used.

Set this property to enable or disable static DNS rules for the class. Works only if UseOwnDNSResolver is set to true.

Supported values are:

noneNo static DNS rules (default)
localLocal static DNS rules
globalGlobal static DNS rules

StaticIPAddress[domain]:   Gets or sets an IP address for the specified domain name.

Use this property to get or set an IP address for the specified domain name in the internal (of the class) or global DNS rules storage depending on the StaticDNS value. The type of the IP address (IPv4 or IPv6) is determined automatically. If both addresses are available, they are devided by the | (pipe) character.

StaticIPAddresses:   Gets or sets all the static DNS rules.

Use this property to get static DNS rules from the current rules storage or restore them back between application sessions. If StaticDNS of the class is set to "local", the property returns/restores the rules from/to the internal storage of the class. If StaticDNS of the class is set to "global", the property returns/restores the rules from/to the GLOBAL storage. The rules list is returned and accepted in JSON format.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

TLSSessionGroup:   Specifies the group name of TLS sessions to be used for session resumption.

Use this property to limit the search of chached TLS sessions to the specified group. Sessions from other groups will be ignored. By default, all sessions are cached with an empty group name and available to all the classes.

TLSSessionLifetime:   Specifies lifetime in seconds of the cached TLS session.

Use this property to specify how much time the TLS session should be kept in the session cache. After this time, the session expires and will be automatically removed from the cache. Default value is 300 seconds (5 minutes).

TLSSessionPurgeInterval:   Specifies how often the session cache should remove the expired TLS sessions.

Use this property to specify the time interval of purging the expired TLS sessions from the session cache. Default value is 60 seconds (1 minute).

UseOwnDNSResolver:   Specifies whether the client components should use own DNS resolver.

Set this global property to false to force all the client components to use the DNS resolver provided by the target OS instead of using own one.

UseSharedSystemStorages:   Specifies whether the validation engine should use a global per-process copy of the system certificate stores.

Set this global property to false to make each validation run use its own copy of system certificate stores.

UseSystemOAEPAndPSS:   Enforces or disables the use of system-driven RSA OAEP and PSS computations.

This global setting defines who is responsible for performing RSA-OAEP and RSA-PSS computations where the private key is stored in a Windows system store and is exportable. If set to true, SBB will delegate the computations to Windows via a CryptoAPI call. Otherwise, it will export the key material and perform the computations using its own OAEP/PSS implementation.

This setting only applies to certificates originating from a Windows system store.

UseSystemRandom:   Enables or disables the use of the OS PRNG.

Use this global property to enable or disable the use of operating system-driven pseudorandom number generation.

Trappable Errors (PGPReader Module)

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