PDFVerify Module

Properties   Methods   Events   Config Settings   Errors  

The PDFVerify module verifies PDF signatures.

Syntax

SecurePDF.PDFVerify

Remarks

The PDFVerify module verifies electronic signatures over PDF documents. Basic Adobe and PAdES signatures are supported.

PDFVerify validates each signature from two perspectives: the integrity and validity of the signature (i.e., its correspondence to the document data it covers), and the validity and trustworthiness of the signing certificate chain. These two signature aspects are generally independent of each other - the signature may be valid but the chain may not be trusted, or the chain may be trusted but the integrity of the signature may be violated. Under normal circumstances, both the signature and the chain must be valid for the signature to be considered good.

Preparing the Validation

For every signature in the document, PDFVerify fires the SignatureInfo event, allowing you to specify whether you want the module to validate the signature, the chain, or both.

Once SignatureInfo returns, PDFVerify proceeds to the signature validation routine in accordance with the provided settings.

Validation Results

Upon completion of the validation, the SignatureProcessed event is fired, and the validation results are published here as well as in the following fields of the associated PDFSignature object:

• ValidationResult contains the outcome of the signature validation: valid, corrupted, the signing certificate was missing, or failed.
• ChainValidationResult contains the primary result of the chain validation routine: valid, valid but untrusted, invalid, or undefined.
• ChainValidationDetails provides the details of the factors that contributed to the chain validation result, such as an outdated certificate, a missing CRL, or a missing CA certificate.

Checking Signature Coverage

Because of these specifics of the PDF format, it is crucially important to understand which part of the document is covered by a specific signature. Use the CoverageEndsAt field of the associated PDFSignature object to establish the scope of a signature. The revision of the document covered by that specific signature ranges from byte 0 to CoverageEndsAt. Alternatively, you can use the GetSignedVersion method to extract the signed revision to a file.

Chain Validation Setup

NOTE: These parameters apply to Sign and Update in PDFSign as well as Verify in PDFVerify, as all three methods execute the chain validation procedure (if it is enabled).

Validation Policy

The ValidationPolicy property dictates how thoroughly the chain is validated. It includes options to control which checks the module performs, allowing you to tailor the validation process to meet your specific security needs. For example, if it is not essential to check each certificate's revocation status, set this property to vpFullNoRevocation.

Revocation

The revocation aspect of chain validation is controlled by the RevocationCheck property, which allows you to choose between and prioritize revocation origins.

NOTE: OCSP sources are often preferred to CRL endpoints because of their real-time capability and the smaller size of the responses they produce.

Trust

The trust aspect of chain validation is controlled by the TrustSources property, which allows you to specify the locations in which the module searches for trust anchors. Local system stores, your own trusted root certificates (through the TrustedCerts collection), and Trusted Lists (through the TrustedLists property) are all supported.

Offline Mode

The OfflineMode property provides the ability to sign or verify the document without contacting online sources. If this property is enabled, the module only uses KnownCerts, TrustedCerts, data structures within the document, and revocation and Trusted List data that it previously saved to its internal cache when looking for missing validation material.

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.

Attachments Property (PDFVerify Module)

A collection of all attached files found in the document.

Syntax

• Swift
• Objective-C

public var attachments: Array<PDFAttachment> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=attachmentCount,setter=setAttachmentCount:) int attachmentCount;

- (int)attachmentCount;
- (void)setAttachmentCount :(int)newAttachmentCount;

- (NSString*)attachmentAFRelationship:(int)attachmentIndex;
- (void)setAttachmentAFRelationship:(int)attachmentIndex :(NSString*)newAttachmentAFRelationship;

- (int)attachmentType:(int)attachmentIndex;

- (NSString*)attachmentContentType:(int)attachmentIndex;
- (void)setAttachmentContentType:(int)attachmentIndex :(NSString*)newAttachmentContentType;

- (NSString*)attachmentCreationDate:(int)attachmentIndex;
- (void)setAttachmentCreationDate:(int)attachmentIndex :(NSString*)newAttachmentCreationDate;

- (NSString*)attachmentData:(int)attachmentIndex;
- (void)setAttachmentData:(int)attachmentIndex :(NSString*)newAttachmentData;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (void)setAttachmentDataB:(int)attachmentIndex :(NSData*)newAttachmentData;

- (NSString*)attachmentDescription:(int)attachmentIndex;
- (void)setAttachmentDescription:(int)attachmentIndex :(NSString*)newAttachmentDescription;

- (NSString*)attachmentFileName:(int)attachmentIndex;
- (void)setAttachmentFileName:(int)attachmentIndex :(NSString*)newAttachmentFileName;

- (NSString*)attachmentModificationDate:(int)attachmentIndex;
- (void)setAttachmentModificationDate:(int)attachmentIndex :(NSString*)newAttachmentModificationDate;

- (NSString*)attachmentName:(int)attachmentIndex;
- (void)setAttachmentName:(int)attachmentIndex :(NSString*)newAttachmentName;

- (long long)attachmentSize:(int)attachmentIndex;

Remarks

This property is used to access the details of all the attached files identified in the document. Use SaveAttachment to save attachments from this collection.

BlockedCerts Property (PDFVerify Module)

The certificates that must be rejected as trust anchors.

Syntax

• Swift
• Objective-C

public var blockedCerts: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=blockedCertCount,setter=setBlockedCertCount:) int blockedCertCount;

- (int)blockedCertCount;
- (void)setBlockedCertCount :(int)newBlockedCertCount;

- (NSString*)blockedCertEffectiveDate:(int)blockedCertIndex;

- (NSString*)blockedCertExpirationDate:(int)blockedCertIndex;

- (NSString*)blockedCertExtendedKeyUsage:(int)blockedCertIndex;

- (NSString*)blockedCertFingerprint:(int)blockedCertIndex;

- (NSString*)blockedCertFingerprintSHA1:(int)blockedCertIndex;

- (NSString*)blockedCertFingerprintSHA256:(int)blockedCertIndex;

- (NSString*)blockedCertIssuer:(int)blockedCertIndex;

- (NSString*)blockedCertPrivateKey:(int)blockedCertIndex;

- (BOOL)blockedCertPrivateKeyAvailable:(int)blockedCertIndex;

- (NSString*)blockedCertPrivateKeyContainer:(int)blockedCertIndex;

- (NSString*)blockedCertPublicKey:(int)blockedCertIndex;

- (NSString*)blockedCertPublicKeyAlgorithm:(int)blockedCertIndex;

- (int)blockedCertPublicKeyLength:(int)blockedCertIndex;

- (NSString*)blockedCertSerialNumber:(int)blockedCertIndex;

- (NSString*)blockedCertSignatureAlgorithm:(int)blockedCertIndex;

- (NSString*)blockedCertStore:(int)blockedCertIndex;
- (void)setBlockedCertStore:(int)blockedCertIndex :(NSString*)newBlockedCertStore;

- (NSData*)blockedCertStoreB:(int)blockedCertIndex;
- (void)setBlockedCertStoreB:(int)blockedCertIndex :(NSData*)newBlockedCertStore;

- (NSString*)blockedCertStorePassword:(int)blockedCertIndex;
- (void)setBlockedCertStorePassword:(int)blockedCertIndex :(NSString*)newBlockedCertStorePassword;

- (int)blockedCertStoreType:(int)blockedCertIndex;
- (void)setBlockedCertStoreType:(int)blockedCertIndex :(int)newBlockedCertStoreType;

- (NSString*)blockedCertSubjectAltNames:(int)blockedCertIndex;

- (NSString*)blockedCertThumbprintMD5:(int)blockedCertIndex;

- (NSString*)blockedCertThumbprintSHA1:(int)blockedCertIndex;

- (NSString*)blockedCertThumbprintSHA256:(int)blockedCertIndex;

- (NSString*)blockedCertUsage:(int)blockedCertIndex;

- (int)blockedCertUsageFlags:(int)blockedCertIndex;

- (NSString*)blockedCertVersion:(int)blockedCertIndex;

- (NSString*)blockedCertSubject:(int)blockedCertIndex;
- (void)setBlockedCertSubject:(int)blockedCertIndex :(NSString*)newBlockedCertSubject;

- (NSString*)blockedCertEncoded:(int)blockedCertIndex;
- (void)setBlockedCertEncoded:(int)blockedCertIndex :(NSString*)newBlockedCertEncoded;

- (NSData*)blockedCertEncodedB:(int)blockedCertIndex;
- (void)setBlockedCertEncodedB:(int)blockedCertIndex :(NSData*)newBlockedCertEncoded;

Remarks

This property is used to supply a list of compromised or blocked certificates to the module. Note that any chain containing a blocked certificate will fail validation.

DecryptionCert Property (PDFVerify Module)

The decryption certificate.

Syntax

• Swift
• Objective-C

public var decryptionCert: Certificate {
  get {...}
  set {...}
}

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

- (NSString*)decryptionCertEffectiveDate;

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

- (NSString*)decryptionCertExpirationDate;

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

- (NSString*)decryptionCertExtendedKeyUsage;

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

- (NSString*)decryptionCertFingerprint;

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

- (NSString*)decryptionCertFingerprintSHA1;

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

- (NSString*)decryptionCertFingerprintSHA256;

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

- (NSString*)decryptionCertIssuer;

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

- (NSString*)decryptionCertPrivateKey;

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

- (BOOL)decryptionCertPrivateKeyAvailable;

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

- (NSString*)decryptionCertPrivateKeyContainer;

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

- (NSString*)decryptionCertPublicKey;

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

- (NSString*)decryptionCertPublicKeyAlgorithm;

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

- (int)decryptionCertPublicKeyLength;

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

- (NSString*)decryptionCertSerialNumber;

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

- (NSString*)decryptionCertSignatureAlgorithm;

@property (nonatomic,readwrite,assign,getter=decryptionCertStore,setter=setDecryptionCertStore:) NSString* decryptionCertStore;

- (NSString*)decryptionCertStore;
- (void)setDecryptionCertStore :(NSString*)newDecryptionCertStore;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreB,setter=setDecryptionCertStoreB:) NSData* decryptionCertStoreB;

- (NSData*)decryptionCertStoreB;
- (void)setDecryptionCertStoreB :(NSData*)newDecryptionCertStore;

@property (nonatomic,readwrite,assign,getter=decryptionCertStorePassword,setter=setDecryptionCertStorePassword:) NSString* decryptionCertStorePassword;

- (NSString*)decryptionCertStorePassword;
- (void)setDecryptionCertStorePassword :(NSString*)newDecryptionCertStorePassword;

@property (nonatomic,readwrite,assign,getter=decryptionCertStoreType,setter=setDecryptionCertStoreType:) int decryptionCertStoreType;

- (int)decryptionCertStoreType;
- (void)setDecryptionCertStoreType :(int)newDecryptionCertStoreType;

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

- (NSString*)decryptionCertSubjectAltNames;

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

- (NSString*)decryptionCertThumbprintMD5;

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

- (NSString*)decryptionCertThumbprintSHA1;

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

- (NSString*)decryptionCertThumbprintSHA256;

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

- (NSString*)decryptionCertUsage;

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

- (int)decryptionCertUsageFlags;

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

- (NSString*)decryptionCertVersion;

@property (nonatomic,readwrite,assign,getter=decryptionCertSubject,setter=setDecryptionCertSubject:) NSString* decryptionCertSubject;

- (NSString*)decryptionCertSubject;
- (void)setDecryptionCertSubject :(NSString*)newDecryptionCertSubject;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncoded,setter=setDecryptionCertEncoded:) NSString* decryptionCertEncoded;

- (NSString*)decryptionCertEncoded;
- (void)setDecryptionCertEncoded :(NSString*)newDecryptionCertEncoded;

@property (nonatomic,readwrite,assign,getter=decryptionCertEncodedB,setter=setDecryptionCertEncodedB:) NSData* decryptionCertEncodedB;

- (NSData*)decryptionCertEncodedB;
- (void)setDecryptionCertEncodedB :(NSData*)newDecryptionCertEncoded;

Remarks

This property is used to provide the certificate used for decryption. Note that this certificate must have a private key associated with it.

DocumentCerts Property (PDFVerify Module)

A collection of certificates read from the document during processing.

Syntax

• Swift
• Objective-C

public var documentCerts: Array<Certificate> {
  get {...}
}

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

- (int)documentCertCount;

- (NSString*)documentCertEffectiveDate:(int)documentCertIndex;

- (NSString*)documentCertExpirationDate:(int)documentCertIndex;

- (NSString*)documentCertExtendedKeyUsage:(int)documentCertIndex;

- (NSString*)documentCertFingerprint:(int)documentCertIndex;

- (NSString*)documentCertFingerprintSHA1:(int)documentCertIndex;

- (NSString*)documentCertFingerprintSHA256:(int)documentCertIndex;

- (NSString*)documentCertIssuer:(int)documentCertIndex;

- (NSString*)documentCertPrivateKey:(int)documentCertIndex;

- (BOOL)documentCertPrivateKeyAvailable:(int)documentCertIndex;

- (NSString*)documentCertPrivateKeyContainer:(int)documentCertIndex;

- (NSString*)documentCertPublicKey:(int)documentCertIndex;

- (NSString*)documentCertPublicKeyAlgorithm:(int)documentCertIndex;

- (int)documentCertPublicKeyLength:(int)documentCertIndex;

- (NSString*)documentCertSerialNumber:(int)documentCertIndex;

- (NSString*)documentCertSignatureAlgorithm:(int)documentCertIndex;

- (NSString*)documentCertStore:(int)documentCertIndex;

- (NSData*)documentCertStoreB:(int)documentCertIndex;

- (NSString*)documentCertStorePassword:(int)documentCertIndex;

- (int)documentCertStoreType:(int)documentCertIndex;

- (NSString*)documentCertSubjectAltNames:(int)documentCertIndex;

- (NSString*)documentCertThumbprintMD5:(int)documentCertIndex;

- (NSString*)documentCertThumbprintSHA1:(int)documentCertIndex;

- (NSString*)documentCertThumbprintSHA256:(int)documentCertIndex;

- (NSString*)documentCertUsage:(int)documentCertIndex;

- (int)documentCertUsageFlags:(int)documentCertIndex;

- (NSString*)documentCertVersion:(int)documentCertIndex;

- (NSString*)documentCertSubject:(int)documentCertIndex;

- (NSString*)documentCertEncoded:(int)documentCertIndex;

- (NSData*)documentCertEncodedB:(int)documentCertIndex;

Remarks

This property is used to access all certificates encountered during document processing and embedded into the signature(s). When signing or verifying, this collection is populated automatically during chain validation.

This property is read-only.

Firewall Property (PDFVerify Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

Remarks

This is a Firewall-type property, which contains fields describing the firewall through which the module will attempt to connect.

InputData Property (PDFVerify Module)

A byte array containing the PDF document to process.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=inputData,setter=setInputData:) NSData* inputData;

- (NSData*)inputData;
- (void)setInputData :(NSData*)newInputData;

Remarks

This property is used to assign a byte array containing the PDF document to be processed.

InputFile Property (PDFVerify Module)

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

This property is used to provide a path to the PDF document to be processed.

KnownCerts Property (PDFVerify Module)

A collection of additional certificates for chain validation.

Syntax

• Swift
• Objective-C

public var knownCerts: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=knownCertCount,setter=setKnownCertCount:) int knownCertCount;

- (int)knownCertCount;
- (void)setKnownCertCount :(int)newKnownCertCount;

- (NSString*)knownCertEffectiveDate:(int)knownCertIndex;

- (NSString*)knownCertExpirationDate:(int)knownCertIndex;

- (NSString*)knownCertExtendedKeyUsage:(int)knownCertIndex;

- (NSString*)knownCertFingerprint:(int)knownCertIndex;

- (NSString*)knownCertFingerprintSHA1:(int)knownCertIndex;

- (NSString*)knownCertFingerprintSHA256:(int)knownCertIndex;

- (NSString*)knownCertIssuer:(int)knownCertIndex;

- (NSString*)knownCertPrivateKey:(int)knownCertIndex;

- (BOOL)knownCertPrivateKeyAvailable:(int)knownCertIndex;

- (NSString*)knownCertPrivateKeyContainer:(int)knownCertIndex;

- (NSString*)knownCertPublicKey:(int)knownCertIndex;

- (NSString*)knownCertPublicKeyAlgorithm:(int)knownCertIndex;

- (int)knownCertPublicKeyLength:(int)knownCertIndex;

- (NSString*)knownCertSerialNumber:(int)knownCertIndex;

- (NSString*)knownCertSignatureAlgorithm:(int)knownCertIndex;

- (NSString*)knownCertStore:(int)knownCertIndex;
- (void)setKnownCertStore:(int)knownCertIndex :(NSString*)newKnownCertStore;

- (NSData*)knownCertStoreB:(int)knownCertIndex;
- (void)setKnownCertStoreB:(int)knownCertIndex :(NSData*)newKnownCertStore;

- (NSString*)knownCertStorePassword:(int)knownCertIndex;
- (void)setKnownCertStorePassword:(int)knownCertIndex :(NSString*)newKnownCertStorePassword;

- (int)knownCertStoreType:(int)knownCertIndex;
- (void)setKnownCertStoreType:(int)knownCertIndex :(int)newKnownCertStoreType;

- (NSString*)knownCertSubjectAltNames:(int)knownCertIndex;

- (NSString*)knownCertThumbprintMD5:(int)knownCertIndex;

- (NSString*)knownCertThumbprintSHA1:(int)knownCertIndex;

- (NSString*)knownCertThumbprintSHA256:(int)knownCertIndex;

- (NSString*)knownCertUsage:(int)knownCertIndex;

- (int)knownCertUsageFlags:(int)knownCertIndex;

- (NSString*)knownCertVersion:(int)knownCertIndex;

- (NSString*)knownCertSubject:(int)knownCertIndex;
- (void)setKnownCertSubject:(int)knownCertIndex :(NSString*)newKnownCertSubject;

- (NSString*)knownCertEncoded:(int)knownCertIndex;
- (void)setKnownCertEncoded:(int)knownCertIndex :(NSString*)newKnownCertEncoded;

- (NSData*)knownCertEncodedB:(int)knownCertIndex;
- (void)setKnownCertEncodedB:(int)knownCertIndex :(NSData*)newKnownCertEncoded;

Remarks

This property is used to supply a list of additional certificates to the module that might be needed for chain validation. For instance, intermediary CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the module manually.

The purpose of this certificate collection is roughly equivalent to that of the Intermediate Certification Authorities system store in Windows.

NOTE: Do not add trust anchors or root certificates to this collection; add them to TrustedCerts instead.

OfflineMode Property (PDFVerify Module)

Whether the module is operating in offline mode.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=offlineMode,setter=setOfflineMode:) BOOL offlineMode;

- (BOOL)offlineMode;
- (void)setOfflineMode :(BOOL)newOfflineMode;

Default Value

False

Remarks

This property indicates whether the module should operate in offline mode.

In offline mode, the module restricts itself from accessing online Trusted Lists and revocation information sources such as CRLs or OCSP responders. It may be useful to set this property to true if there is a need to verify the completeness of the validation information included within the signature or provided via KnownCerts.

OutputData Property (PDFVerify Module)

A byte array containing the PDF document after processing.

Syntax

• Swift
• Objective-C

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

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

- (NSData*)outputData;

Remarks

This property is used to read the byte array containing the produced output after the operation has completed. It is only set if an output file has not been assigned via OutputFile.

This property is read-only.

OutputFile Property (PDFVerify Module)

The path to a local file where the output is written.

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

This property is used to provide a path where the resulting PDF document is saved after the operation has completed.

Overwrite Property (PDFVerify Module)

Whether the module should overwrite files.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=overwrite,setter=setOverwrite:) BOOL overwrite;

- (BOOL)overwrite;
- (void)setOverwrite :(BOOL)newOverwrite;

Default Value

False

Remarks

This property indicates whether the module overwrites OutputFile. If set to false, an error is thrown whenever OutputFile exists before an operation.

Password Property (PDFVerify Module)

The password to decrypt the document with.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

This property is used to provide the user password for decryption. Though it may be different from OwnerPassword, most implementations use the same value for both.

PDFAConformanceLevel Property (PDFVerify Module)

The PDF/A conformance level of the document.

Syntax

• Swift
• Objective-C

public var pdfaConformanceLevel: PDFVerifyPDFAConformanceLevels {
  get {...}
  set {...}
}

public enum PDFVerifyPDFAConformanceLevels: Int32 {
  case paclNone = 0
  case paclA1a = 1
  case paclA1b = 2
  case paclA2a = 3
  case paclA2b = 4
  case paclA2u = 5
  case paclA3a = 6
  case paclA3b = 7
  case paclA3u = 8
  case paclA4 = 9
  case paclA4e = 10
  case paclA4f = 11
}

@property (nonatomic,readwrite,assign,getter=PDFAConformanceLevel,setter=setPDFAConformanceLevel:) int PDFAConformanceLevel;

- (int)PDFAConformanceLevel;
- (void)setPDFAConformanceLevel :(int)newPDFAConformanceLevel;

Default Value

0

Remarks

This property is used to specify the desired PDF/A conformance level the module attempts to apply when operating on the document.

Possible values are:

Proxy Property (PDFVerify Module)

A set of properties related to proxy access.

Syntax

• Swift
• Objective-C

public var proxy: Proxy {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=proxyAuthScheme,setter=setProxyAuthScheme:) int proxyAuthScheme;

- (int)proxyAuthScheme;
- (void)setProxyAuthScheme :(int)newProxyAuthScheme;

@property (nonatomic,readwrite,assign,getter=proxyAutoDetect,setter=setProxyAutoDetect:) BOOL proxyAutoDetect;

- (BOOL)proxyAutoDetect;
- (void)setProxyAutoDetect :(BOOL)newProxyAutoDetect;

@property (nonatomic,readwrite,assign,getter=proxyPassword,setter=setProxyPassword:) NSString* proxyPassword;

- (NSString*)proxyPassword;
- (void)setProxyPassword :(NSString*)newProxyPassword;

@property (nonatomic,readwrite,assign,getter=proxyPort,setter=setProxyPort:) int proxyPort;

- (int)proxyPort;
- (void)setProxyPort :(int)newProxyPort;

@property (nonatomic,readwrite,assign,getter=proxyServer,setter=setProxyServer:) NSString* proxyServer;

- (NSString*)proxyServer;
- (void)setProxyServer :(NSString*)newProxyServer;

@property (nonatomic,readwrite,assign,getter=proxySSL,setter=setProxySSL:) int proxySSL;

- (int)proxySSL;
- (void)setProxySSL :(int)newProxySSL;

@property (nonatomic,readwrite,assign,getter=proxyUser,setter=setProxyUser:) NSString* proxyUser;

- (NSString*)proxyUser;
- (void)setProxyUser :(NSString*)newProxyUser;

Remarks

This property contains fields describing the proxy through which the module will attempt to connect.

RevocationCheck Property (PDFVerify Module)

The kind(s) of revocation check to perform for all chain certificates.

Syntax

• Swift
• Objective-C

public var revocationCheck: PDFVerifyRevocationChecks {
  get {...}
  set {...}
}

public enum PDFVerifyRevocationChecks: Int32 {
  case rcAllCRL = 0
  case rcAllOCSP = 1
  case rcAllCRLAndOCSP = 2
  case rcAnyCRL = 3
  case rcAnyOCSP = 4
  case rcAnyCRLOrOCSP = 5
  case rcAnyOCSPOrCRL = 6
}

@property (nonatomic,readwrite,assign,getter=revocationCheck,setter=setRevocationCheck:) int revocationCheck;

- (int)revocationCheck;
- (void)setRevocationCheck :(int)newRevocationCheck;

Default Value

6

Remarks

This property is used to specify the revocation sources and preferences the module uses during chain validation. Revocation checking is necessary to ensure the integrity of the chain and to obtain up-to-date certificate validity and trust information.

Certificate Revocation Lists (CRLs) and Online Certificate Status Protocol (OCSP) responses serve the same purpose of ensuring that the certificate has not been revoked by the Certificate Authority (CA) at the time of use. Depending on the circumstances and security policy requirements, either one or both of the revocation information source types may be used.

Possible values are:

This property controls the way revocation checks are performed for every certificate in the chain. Typically, certificates come with two types of revocation information sources: CRLs (Certificate Revocation Lists) and OCSP responses. CRLs are static objects periodically published by the CA at some online location. OCSP responders are active online services maintained by the CA that can provide up-to-date information on certificate statuses in near real time.

There are some conceptual differences between the two. CRLs are normally larger in size. Their use involves some latency because there is normally a delay between the time at which a certificate was revoked and the time at which the subsequent CRL mentioning that revocation is published. The benefits of CRLs are that the same object can provide statuses for all certificates issued by a particular CA, and that the whole technology is much simpler than OCSP (and thus is supported by more CAs).

This property allows the validation course to be adjusted by including or excluding certain types of revocation sources from the validation process. The rcAnyOCSPOrCRL setting (give preference to the faster OCSP route and only demand one source to succeed) is a good choice for most typical validation environments. The rcAll* modes are much stricter, and may be used in scenarios where bulletproof validity information is essential.

NOTE: If no CRL or OCSP endpoints are provided by the CA, the revocation check is considered successful. This is because the CA chose not to supply revocation information for its certificates, meaning they are considered irrevocable.

NOTE: Within each of the above settings, if any retrieved CRL or OCSP response indicates that the certificate has been revoked, the revocation check fails.

Signatures Property (PDFVerify Module)

A collection of all the signatures and empty fields found in the document.

Syntax

• Swift
• Objective-C

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

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

- (int)PDFSignatureCount;

- (NSString*)PDFSignatureAuthorName:(int)pDFSignatureIndex;

- (int)PDFSignatureChainValidationDetails:(int)pDFSignatureIndex;

- (int)PDFSignatureChainValidationResult:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureClaimedSigningTime:(int)pDFSignatureIndex;

- (int)PDFSignatureCoverageEndsAt:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureHashAlgorithm:(int)pDFSignatureIndex;

- (int)PDFSignatureProfile:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureReason:(int)pDFSignatureIndex;

- (int)PDFSignatureType:(int)pDFSignatureIndex;

- (int)PDFSignatureSignerCertIndex:(int)pDFSignatureIndex;

- (int)PDFSignatureTimestampCertIndex:(int)pDFSignatureIndex;

- (BOOL)PDFSignatureTimestamped:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureValidatedSigningTime:(int)pDFSignatureIndex;

- (int)PDFSignatureValidationResult:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureWidgetHeight:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureWidgetOffsetX:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureWidgetOffsetY:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureWidgetPages:(int)pDFSignatureIndex;

- (NSString*)PDFSignatureWidgetWidth:(int)pDFSignatureIndex;

Remarks

This property is used to access the details of all the signatures and empty signature fields identified in the document.

This property is read-only.

TrustedCerts Property (PDFVerify Module)

A collection of trusted certificates for chain validation.

Syntax

• Swift
• Objective-C

public var trustedCerts: Array<Certificate> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=trustedCertCount,setter=setTrustedCertCount:) int trustedCertCount;

- (int)trustedCertCount;
- (void)setTrustedCertCount :(int)newTrustedCertCount;

- (NSString*)trustedCertEffectiveDate:(int)trustedCertIndex;

- (NSString*)trustedCertExpirationDate:(int)trustedCertIndex;

- (NSString*)trustedCertExtendedKeyUsage:(int)trustedCertIndex;

- (NSString*)trustedCertFingerprint:(int)trustedCertIndex;

- (NSString*)trustedCertFingerprintSHA1:(int)trustedCertIndex;

- (NSString*)trustedCertFingerprintSHA256:(int)trustedCertIndex;

- (NSString*)trustedCertIssuer:(int)trustedCertIndex;

- (NSString*)trustedCertPrivateKey:(int)trustedCertIndex;

- (BOOL)trustedCertPrivateKeyAvailable:(int)trustedCertIndex;

- (NSString*)trustedCertPrivateKeyContainer:(int)trustedCertIndex;

- (NSString*)trustedCertPublicKey:(int)trustedCertIndex;

- (NSString*)trustedCertPublicKeyAlgorithm:(int)trustedCertIndex;

- (int)trustedCertPublicKeyLength:(int)trustedCertIndex;

- (NSString*)trustedCertSerialNumber:(int)trustedCertIndex;

- (NSString*)trustedCertSignatureAlgorithm:(int)trustedCertIndex;

- (NSString*)trustedCertStore:(int)trustedCertIndex;
- (void)setTrustedCertStore:(int)trustedCertIndex :(NSString*)newTrustedCertStore;

- (NSData*)trustedCertStoreB:(int)trustedCertIndex;
- (void)setTrustedCertStoreB:(int)trustedCertIndex :(NSData*)newTrustedCertStore;

- (NSString*)trustedCertStorePassword:(int)trustedCertIndex;
- (void)setTrustedCertStorePassword:(int)trustedCertIndex :(NSString*)newTrustedCertStorePassword;

- (int)trustedCertStoreType:(int)trustedCertIndex;
- (void)setTrustedCertStoreType:(int)trustedCertIndex :(int)newTrustedCertStoreType;

- (NSString*)trustedCertSubjectAltNames:(int)trustedCertIndex;

- (NSString*)trustedCertThumbprintMD5:(int)trustedCertIndex;

- (NSString*)trustedCertThumbprintSHA1:(int)trustedCertIndex;

- (NSString*)trustedCertThumbprintSHA256:(int)trustedCertIndex;

- (NSString*)trustedCertUsage:(int)trustedCertIndex;

- (int)trustedCertUsageFlags:(int)trustedCertIndex;

- (NSString*)trustedCertVersion:(int)trustedCertIndex;

- (NSString*)trustedCertSubject:(int)trustedCertIndex;
- (void)setTrustedCertSubject:(int)trustedCertIndex :(NSString*)newTrustedCertSubject;

- (NSString*)trustedCertEncoded:(int)trustedCertIndex;
- (void)setTrustedCertEncoded:(int)trustedCertIndex :(NSString*)newTrustedCertEncoded;

- (NSData*)trustedCertEncodedB:(int)trustedCertIndex;
- (void)setTrustedCertEncodedB:(int)trustedCertIndex :(NSData*)newTrustedCertEncoded;

Remarks

This property is used to supply a list of trusted certificates to the module that might be needed for chain validation. For instance, root CA certificates may be absent from the standard system locations (or there may be no standard system locations) and therefore should be supplied to the module manually.

The purpose of this certificate collection is largely the same as that of the Windows Trusted Root Certification Authorities system store.

Use this property with extreme care as it directly affects chain verifiability; a wrong certificate added to the list of trusted certificates may result in bad chains being accepted and forged signatures being recognized as genuine. Only add certificates that originate from parties that are known and trusted.

TrustedLists Property (PDFVerify Module)

A list of known Trusted Lists for chain validation.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=trustedLists,setter=setTrustedLists:) NSString* trustedLists;

- (NSString*)trustedLists;
- (void)setTrustedLists :(NSString*)newTrustedLists;

Default Value

"%EUTL%"

Remarks

This property is used to supply a semicolon-separated list of URLs or paths of known Trusted Lists to the module for chain validation.

A Trusted List is an XML document that contains a government-issued list of CAs that have passed regulated compliance checks. When validating the chain, the module consults the Trusted List to establish certificate trust, ensuring that the CA is legitimate and entitled to issue certificates of the kind being checked.

The default value is the special %EUTL% macro, which, if applicable, instructs the module to check the root certificate against up-to-date versions of the primary EU Trusted Lists from the EU LOTL. Custom values can be appended: component.TrustedLists = "%EUTL%;http://my.company/tsl;c:\tsls\mytsl.xml"; NOTE: The module caches all Trusted Lists it downloads and uses during chain validation. This cache is shared between module instances within the same process. If this property contains a URL that is also present in the cache, the module retrieves the cached data and reuses it in the current validation. If the data is invalid, the module downloads a fresh Trusted List and adds it to the cache.

TrustSources Property (PDFVerify Module)

The trust sources to use during chain validation.

Syntax

• Swift
• Objective-C

public var trustSources: PDFVerifyTrustSources {
  get {...}
  set {...}
}

public enum PDFVerifyTrustSources: Int32 {
  case tsManual = 0
  case tsLocal = 1
  case tsTrustedLists = 2
  case tsLocalAndTrustedLists = 3
}

@property (nonatomic,readwrite,assign,getter=trustSources,setter=setTrustSources:) int trustSources;

- (int)trustSources;
- (void)setTrustSources :(int)newTrustSources;

Default Value

3

Remarks

This property is used to specify the sources the module uses to establish certificate trust during chain validation.

Establishing trust for a particular certificate, when either signing or verifying, involves building a chain up to a valid trust anchor. This trust anchor is a root certificate that typically resides on the local system. If the certificate does not eventually chain up to a valid trust anchor, the chain is considered untrusted and therefore invalid.

Possible values are:

ValidationFlags Property (PDFVerify Module)

Additional chain validation settings.

Syntax

• Swift
• Objective-C

public var validationFlags: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=validationFlags,setter=setValidationFlags:) int validationFlags;

- (int)validationFlags;
- (void)setValidationFlags :(int)newValidationFlags;

Default Value

0

Remarks

This property is used to specify additional settings that affect the overall flow of the chain validation.

Its value should be provided as a bitmask of the following flags:

ValidationPolicy Property (PDFVerify Module)

The level at which to perform chain validation.

Syntax

• Swift
• Objective-C

public var validationPolicy: PDFVerifyValidationPolicies {
  get {...}
  set {...}
}

public enum PDFVerifyValidationPolicies: Int32 {
  case vpNone = 0
  case vpFull = 1
  case vpFullNoTrust = 2
  case vpFullNoRevocation = 3
  case vpBestEffort = 4
}

@property (nonatomic,readwrite,assign,getter=validationPolicy,setter=setValidationPolicy:) int validationPolicy;

- (int)validationPolicy;
- (void)setValidationPolicy :(int)newValidationPolicy;

Default Value

1

Remarks

This property is used to specify the overall validation policy the module follows.

Possible values are:

Validation Policy Heuristics

Creating a new signature:

• For a basic signature with or without a timestamp, chain validation is not required, so it is recommended to use vpNone. This policy may also be used in test environments or on offline systems.
• For an LTV signature, use vpFull or vpFullNoTrust depending on whether trust checks are necessary in the current environment. If the signature is being created in an environment that does not match the prospective validation environment, consider vpFullNoTrust to validate the chain properly and fully without expecting good trust.

Updating or extending an existing signature:

• When updating a basic signature to LTV, similarly use vpFull or vpFullNoTrust as above.
• When extending an LTV signature, similarly use vpFull or vpFullNoTrust as above.

Validating an existing signature:

• For basic signature validation, use vpFullNoRevocation if trust checks, but not revocation checks, are necessary in the current environment. This policy may also be used on offline systems if the trust anchor is already available to the module.
• For archival validation, use vpFull to validate the chain properly and fully. This policy expects the trust anchor and all the revocation material to be available.

ValidationTime Property (PDFVerify Module)

The time point at which the signature should be validated.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=validationTime,setter=setValidationTime:) NSString* validationTime;

- (NSString*)validationTime;
- (void)setValidationTime :(NSString*)newValidationTime;

Default Value

""

Remarks

This property is used to specify the moment in time at which the signature validity should be established. The time should be provided in UTC in yyyyMMddHHmmssZ format.

Leave this property empty to stick to the default time point. The module then prioritizes:

• The signature creation time if the signature contains a signature timestamp (ValidatedSigningTime), or
• The local time included in the signature by the signer (ClaimedSigningTime).

Close Method (PDFVerify Module)

Closes the opened document.

Syntax

• Swift
• Objective-C

public func close() throws -> Void

- (void)close;

Remarks

This method is used to close the previously opened document. It should always be preceded by a call to Open.

Example: component.InputFile = "input.pdf"; component.Open(); // Some operation component.Close(); If any changes are made to the document, they are saved automatically to OutputFile or OutputData when this method is called. To configure this saving behavior, set SaveChanges.

Config Method (PDFVerify 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 module. It is used to set and retrieve configuration settings for the module.

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

Encrypted Method (PDFVerify Module)

Checks whether the document is encrypted.

Syntax

• Swift
• Objective-C

public func encrypted() throws -> Bool

- (BOOL)encrypted;

Remarks

This method is used to determine whether the document is encrypted. It returns false if the document is pseudo-encrypted with an empty password.

Example: component.InputFile = "input.pdf"; if (component.Encrypted()) { // Set Password or DecryptionCert } component.Open(); // Some operation component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetPageProperty Method (PDFVerify Module)

Returns the value of a page property.

Syntax

• Swift
• Objective-C

public func getPageProperty(pageIndex: Int32, pageProperty: String) throws -> String

- (NSString*)getPageProperty :(int)pageIndex :(NSString*)pageProperty;

Remarks

This method is used to obtain general information about the pages of the document, such as their dimensions and content positioning details.

PageIndex specifies the page to read information about (with a valid range from 0 to PageCount - 1), and PageProperty specifies the page property to read. Possible values are:

Example: int pageCount = 0; component.OnDocumentInfo += (s, e) => { pageCount = e.PageCount; }; component.InputFile = "input.pdf"; component.Open(); for (int i = 0; i < pageCount; i++) component.GetPageProperty(i, "Height"); component.Close(); The page properties can be used to adjust the position of the signature widget based on the page dimensions. For example: int x = int.Parse(pdfsign.GetPageProperty(0, "Width")) - 100; int y = int.Parse(pdfsign.GetPageProperty(0, "Height")) - 100; pdfsign.SetWidgetProperty("OffsetX", x.ToString()); pdfsign.SetWidgetProperty("OffsetY", y.ToString()); NOTE: Each page property is only populated once the document has been loaded, which is reported by the DocumentInfo event.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

GetSignedVersion Method (PDFVerify Module)

Returns the part of the signed document that is covered by a signature.

Syntax

• Swift
• Objective-C

public func getSignedVersion(signatureIndex: Int32) throws -> Void

- (void)getSignedVersion :(int)signatureIndex;

Remarks

This method is used to obtain the revision of the document that is covered by a signature.

SignatureIndex is the index of the signature of interest in the Signatures collection.

Example: pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "revision0.pdf"; pdfverify.GetSignedVersion(0); PDF documents often use an incremental update approach, with any changes being appended to the document without altering the existing revision. This may lead to situations where a signature only covers part of the document (one of the past revisions), but not subsequent changes. This method provides a means to extract the revision that is actually certified by the signature.

It is recommended to use this method when validating signatures to make sure the signature covers the byte range it is expected to cover.

An alternative to this method is to check the CoverageEndsAt field of the signature object and match it to the document length.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Interrupt Method (PDFVerify Module)

Interrupts the current action.

Syntax

• Swift
• Objective-C

public func interrupt() throws -> Void

- (void)interrupt;

Remarks

This method interrupts the current action. It can be used, for example, within the ChainCert event to abort the chain validation procedure.

If there is no action in progress, this method simply returns, doing nothing.

Open Method (PDFVerify Module)

Opens the document for processing.

Syntax

• Swift
• Objective-C

public func open() throws -> Void

- (void)open;

Remarks

This method is used to open the document specified in InputFile or InputData before performing some operation on it, such as verifying or removing signatures. When finished, call Close to complete or discard the operation.

It is recommended to use this method (alongside Close) when performing multiple operations on the document at once.

NOTE: This method populates the Attachments, DocumentCerts, and Signatures collections with any corresponding objects found in the document.

Automatic Decryption Functionality

Once the correct decryption material is supplied, the module then attempts to decrypt the document automatically within this method. When this occurs, the decrypted content is kept in memory so that the document's encrypted status is preserved when it is saved later. Use Decrypt to save a decrypted copy of the document instead.

Reset Method (PDFVerify Module)

Resets the module.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method is used to reset the module's properties and configuration settings to their default values.

SaveAttachment Method (PDFVerify Module)

Saves a PDF attachment to a file.

Syntax

• Swift
• Objective-C

public func saveAttachment(index: Int32, fileName: String) throws -> Void

- (void)saveAttachment :(int)index :(NSString*)fileName;

Remarks

This method is used to retrieve the contents of an attachment from the document and save it to a file. It does not modify the contents of the Attachments collection.

Index is the index of the attachment in the Attachments collection to be saved.

FileName specifies the filename that the attachment will be saved to.

Example: component.InputFile = "input_with_attachment.pdf"; component.Open(); component.SaveAttachment(0, "a.dat"); component.Close(); NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Signed Method (PDFVerify Module)

Checks whether the document is signed.

Syntax

• Swift
• Objective-C

public func signed() throws -> Bool

- (BOOL)signed;

Remarks

This method is used to determine whether the document is signed. It returns false if the document contains only empty signature fields.

Example: pdfverify.InputFile = "input.pdf"; if (pdfverify.Signed()) { // Configure validation-related properties as desired pdfverify.Verify(); } NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Unsign Method (PDFVerify Module)

Removes a signature from the document.

Syntax

• Swift
• Objective-C

public func unsign(signatureIndex: Int32, unsignKind: Int32) throws -> Void

- (void)unsign :(int)signatureIndex :(int)unsignKind;

Remarks

This method is used to remove an existing signature from the document.

SignatureIndex is the index of the signature in the Signatures collection to be removed.

UnsignKind specifies the kind of unsign to perform. Possible values are:

Example: pdfverify.InputFile = "signed.pdf"; pdfverify.OutputFile = "unsigned.pdf"; pdfverify.Open(); int idx = pdfverify.Signatures.Count - 1; pdfverify.Unsign(idx, 0); // uskFull pdfverify.Close(); Note that unsigning is different from GetSignedVersion. The latter returns the revision of the document including the mentioned signature (thus removing anything after that signature was created). Unsign removes the signature completely by carving it out of the document.

NOTE: SignatureIndex set to -1 removes all signatures in the document.

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

Verify Method (PDFVerify Module)

Verifies the signed document.

Syntax

• Swift
• Objective-C

public func verify() throws -> Void

- (void)verify;

Remarks

This method is used to validate all signatures in the document.

This method walks through the signed document and reports every signature via the SignatureInfo event. Subscribe to the event to be notified about the signatures and adjust validation settings on the fly.

Upon completion of this method, the signature details will be published in the Signatures collection.

Example: pdfverify.InputFile = "signed.pdf"; pdfverify.Verify(); PDFSignature signature = pdfverify.Signatures[0]; if (signature.ValidationResult == SignatureValidationResults.svrValid) Console.WriteLine("Signature is good"); if (signature.ChainValidationResult == ChainValidationResults.cvrValid) Console.WriteLine("Chain is good"); This method only validates the signatures and does not check their coverage. It is a good idea to use mechanisms such as GetSignedVersion or CoverageEndsAt to ensure that the signature covers the expected document revision.

To control individual signature validation, subscribe to the SignatureInfo event and set the ValidateSignature and ValidateChain parameters accordingly. The results are reported via the SignatureProcessed event.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

NOTE: If the document is not already opened, this method opens it, performs the operation, then closes it.

ChainCert Event (PDFVerify Module)

Fired when the module encounters a chain certificate.

Syntax

• Swift
• Objective-C

func onChainCert(certEncoded: Data, certSubject: String, certIssuer: String, validationTime: String, validationResult: inout Int32, validationDetails: inout Int32)

- (void)onChainCert :(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)validationTime :(int*)validationResult :(int*)validationDetails;

Remarks

This event is fired once for each certificate encountered during chain validation to report that it is about to be processed. The module tries to retrieve all required chain certificates automatically.

CertEncoded specifies the PEM (Base64-encoded) public certificate.

CertSubject and CertIssuer specify the distinguished names of the certificate owner and issuer respectively.

ValidationTime specifies the time point (in UTC) at which the certificate validity was established.

ValidationResult reports the outcome of the individual certificate validation and can be one of the following values:

In the case of a failure, ValidationDetails provides more details on its reasons. Its value is a bitmask of the following flags:

Overridable Chain Validation

For example, set ValidationResult to cvrValid and ValidationDetails to 0 in order to:

• Ignore CA or TLS key usage requirements
• Ignore the AuthorityKeyId extension in certificate-issuing CAs (helps with incorrectly renewed certificates)
• Ignore the Basic Constraints or Name Constraints extensions of CA certificates
• Tolerate some weaker algorithms
• Implicitly trust self-signed certificates
• Skip validity period checks for trusted certificates (helps with older devices that have expired root certificates)
• Ignore chain loops (helps with buggy CAs that include subchains that sign themselves)

NOTE: The user code is ultimately responsible for certificate validity decisions made via these two parameters. If their values are modified within this event, the resulting chain validation procedure may deviate from the standard.

DocumentInfo Event (PDFVerify Module)

Fired when the document has been loaded into memory.

Syntax

• Swift
• Objective-C

func onDocumentInfo(pageCount: Int32, signatureCount: Int32)

- (void)onDocumentInfo :(int)pageCount :(int)signatureCount;

Remarks

This event is fired once per document processing routine to report that the document has been processed and loaded into memory.

The handler for this event is a good place to check the document structure and access document-related information such as page number and document file details. These may be useful when preparing the signature. For example, GetPageProperty can be used to find the optimal position for the signature widget.

PageCount reports the number of pages in the document.

SignatureCount reports the number of signatures in the document.

This event is fired when Open is called, but only after Password or RecipientInfo is fired (if applicable) and the document has been decrypted.

Error Event (PDFVerify Module)

Fired when information is available about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the module .

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (PDFVerify Module)

Fired once for each log message.

Syntax

• Swift
• Objective-C

func onLog(logLevel: Int32, message: String, logType: String)

- (void)onLog :(int)logLevel :(NSString*)message :(NSString*)logType;

Remarks

This event is fired once for each log message generated by the module. The verbosity is controlled by the LogLevel configuration setting.

LogLevel indicates the detail level of the message. Possible values are:

Message is the log message.

LogType identifies the type of log entry. Possible values are:

• CertValidator
• Font
• HTTP
• PDFInvalidSignature
• PDFRevocationInfo
• Timestamp
• TSL

Password Event (PDFVerify Module)

Fired when the module detects that the document is encrypted with a password.

Syntax

• Swift
• Objective-C

func onPassword(available: Bool, cancel: inout Bool)

- (void)onPassword :(BOOL)available :(int*)cancel;

Remarks

This event is fired during document processing to report that the document is encrypted with a password. It may be used to supply the correct decryption password to Password.

Available indicates whether the decryption password is already available to the module or still needs to be set. If this parameter is false, the correct password must be provided for the decryption attempt to succeed.

Cancel determines whether the module will stop firing this event to request a password.

RecipientInfo Event (PDFVerify Module)

Fired for each recipient certificate of the encrypted document.

Syntax

• Swift
• Objective-C

func onRecipientInfo(issuer: String, serialNumber: String, subjectKeyIdentifier: String, available: Bool, cancel: inout Bool)

- (void)onRecipientInfo :(NSString*)issuer :(NSString*)serialNumber :(NSString*)subjectKeyIdentifier :(BOOL)available :(int*)cancel;

Remarks

This event is fired during document processing for each recipient certificate that the document has been encrypted for (if applicable). It may be used to identify the certificate(s) to load and supply to DecryptionCert.

Issuer specifies the subject of the issuer certificate.

SerialNumber specifies the serial number of the encryption certificate.

SubjectKeyIdentifier specifies the X.509 subjectKeyIdentifier extension value of the encryption certificate, encoded as a hex string.

Available indicates whether the decryption certificate is already available to the module or still needs to be set. If this parameter is false, the correct certificate must be provided for the decryption attempt to succeed.

Cancel determines whether the module will stop firing this event to request a certificate.

NOTE: The document may be encrypted with more than one certificate (or have "more than one recipient"), in which case each certificate causes its own invocation of this event.

SignatureInfo Event (PDFVerify Module)

Fired when the module finds a signature in the document.

Syntax

• Swift
• Objective-C

func onSignatureInfo(signatureIndex: Int32, validateSignature: inout Bool, validateChain: inout Bool)

- (void)onSignatureInfo :(int)signatureIndex :(int*)validateSignature :(int*)validateChain;

Remarks

This event is fired once for each signature found in the document to report that it is about to be validated.

SignatureIndex is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. ValidateSignature and ValidateChain determine whether each stage should be included in the validation. They can be overridden to modify the validation policy on a per-signature basis, allowing signatures to be verified individually instead of all at once (via Verify). To skip validation entirely, set both parameters to false.

Use the following properties to adjust chain validation parameters:

• BlockedCerts
• KnownCerts
• OfflineMode
• RevocationCheck
• TrustedCerts
• TrustedLists
• TrustSources
• ValidationFlags
• ValidationPolicy
• ValidationTime

SignatureProcessed Event (PDFVerify Module)

Fired after a signature has been processed.

Syntax

• Swift
• Objective-C

func onSignatureProcessed(signatureIndex: Int32, signatureValidationResult: Int32, chainValidationResult: Int32, chainValidationDetails: Int32)

- (void)onSignatureProcessed :(int)signatureIndex :(int)signatureValidationResult :(int)chainValidationResult :(int)chainValidationDetails;

Remarks

This event is fired once for each signature found in the document to report that it has completed validation. It is fired after SignatureInfo if that event's ValidateSignature parameter is set to true.

SignatureIndex is the index of the signature in the Signatures collection.

Signature validation consists of two independent stages: cryptographic signature validation and chain validation. Separate validation results are reported for each in SignatureValidationResult and ChainValidationResult.

The former reports the validity of the signature and can be one of the following values:

The latter reports the validity of the chain and can be one of the following values:

In the case of a failure, ChainValidationDetails provides more details on its reasons. Its value is a bitmask of the following flags:

NOTE: SignatureValidationResult, ChainValidationResult, and ChainValidationDetails are also available as fields in the PDFSignature type.

SSLServerAuthentication Event (PDFVerify Module)

Fired after the server presents its certificate to the client.

Syntax

• Swift
• Objective-C

func onSSLServerAuthentication(certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLServerAuthentication :(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

This event is fired during timestamping or chain validation after the server presents its SSL/TLS certificate to the module. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

During this event, the client can decide whether to continue with the connection process. Accept is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether to continue.

When Accept is false, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting Accept to true.

SSLStatus Event (PDFVerify Module)

Fired when secure connection progress messages are available.

Syntax

• Swift
• Objective-C

func onSSLStatus(message: String)

- (void)onSSLStatus :(NSString*)message;

Remarks

This event is fired during timestamping or chain validation for informational and logging purposes only. This event tracks the progress of the SSL/TLS connection. It only applies if the TSA, CRL, OCSP, or Trusted List endpoint operates over HTTPS.

Certificate Type

This is the digital certificate being used.

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

• EffectiveDate
• ExpirationDate
• ExtendedKeyUsage
• Fingerprint
• FingerprintSHA1
• FingerprintSHA256
• Issuer
• PrivateKey
• PrivateKeyAvailable
• PrivateKeyContainer
• PublicKey
• PublicKeyAlgorithm
• PublicKeyLength
• SerialNumber
• SignatureAlgorithm
• Store
• StorePassword
• StoreType
• SubjectAltNames
• ThumbprintMD5
• ThumbprintSHA1
• ThumbprintSHA256
• Usage
• UsageFlags
• Version
• Subject
• Encoded

Fields

Constructors

public init()

public init(encoded: Data)

public init(storeType: CertStoreTypes, store: String, storePassword: String, subject: String)

public init(storeType: CertStoreTypes, store: Data, storePassword: String, subject: String)

Firewall Type

The firewall the module will connect through.

Remarks

When connecting through a firewall, this type is used to specify different properties of the firewall, such as the firewall Host and the FirewallType.

• AutoDetect
• FirewallType
• Host
• Password
• Port
• User

Fields

Constructors

public init()

PDFAttachment Type

The file being attached to the PDF document.

Remarks

This type contains information about the file that is being attached to the document.

• AFRelationship
• AttachmentType
• ContentType
• CreationDate
• Data
• Description
• FileName
• ModificationDate
• Name
• Size

Fields

Constructors

public init()

public init(fileName: String)

public init(fileName: String, description_: String)

public init(data: Data, name: String, description_: String)

PDFSignature Type

A container for PDF signature details.

Remarks

This type contains details about the signature. Use it to read information about the signature when processing it.

• AuthorName
• ChainValidationDetails
• ChainValidationResult
• ClaimedSigningTime
• CoverageEndsAt
• HashAlgorithm
• Profile
• Reason
• SignatureType
• SignerCertIndex
• TimestampCertIndex
• Timestamped
• ValidatedSigningTime
• ValidationResult
• WidgetHeight
• WidgetOffsetX
• WidgetOffsetY
• WidgetPages
• WidgetWidth

Fields

Constructors

public init()

Proxy Type

The proxy the module will connect to.

Remarks

When connecting through a proxy, this type is used to specify different properties of the proxy, such as the Server and the AuthScheme.

• AuthScheme
• AutoDetect
• Password
• Port
• Server
• SSL
• User

Fields

Constructors

public init()

public init(server: String, port: Int32)

public init(server: String, port: Int32, user: String, password: String)

Config Settings (PDFVerify Module)

PDFVerify Config Settings

Base Config Settings

Trappable Errors (PDFVerify Module)

PDFVerify Errors

PDF Errors

Parsing Errors

HTTP Errors

TCPClient Errors

SSL Errors

TCP/IP Errors