Docs

SecureBlackbox 2022 macOS Edition

Version 22.0 [Build 8174]

PDFEncryptor Module

Properties   Methods   Events   Configuration Settings   Errors  

The PDFEncryptor module encrypts PDF documents.

Syntax

SecureBlackbox.Pdfencryptor

Remarks

PDFEncryptor encrypts PDF documents with passwords or certificates.

Property List


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

EncryptionAlgorithmThe encryption algorithm to encrypt the document with.
EncryptionCertificateThe encryption certificate.
EncryptionCertificatesThe encryption certificates.
EncryptionTypeThe encryption type.
EncryptMetadataSpecifies whether to encrypt the document metadata.
FIPSModeReserved.
InputBytesUse this property to pass the input to module in the byte array form.
InputFileThe PDF file to be encrypted.
OutputBytesUse this property to read the output the module object has produced.
OutputFileThe file to save the encrypted document to.
OwnerPasswordThe owner password.
PermissionsSpecifies the document permissions associated with the encryption.
UserPasswordThe user password.

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.
DoActionPerforms an additional action.
EncryptEncrypts the PDF document.

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.

ErrorInformation about errors during encryption.
NotificationThis event notifies the application about an underlying control flow event.

Configuration Settings


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

EncryptionHandlerNameSpecifies the custom security handler PDF-name.
HardenedKeyGenerationSpecifies if hardened Key generation should be used.
RC4KeyBitsSpecifies the number of key bits used for RC4 algorithm.
TempPathLocation where the temporary files are stored.
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 (supported for HTTPClient, RESTClient and SOAPClient only).
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.
TagAllows to store any custom data.
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.

EncryptionAlgorithm Property (PDFEncryptor Module)

The encryption algorithm to encrypt the document with.

Syntax

public var encryptionAlgorithm: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=encryptionAlgorithm,setter=setEncryptionAlgorithm:) NSString* encryptionAlgorithm;

- (NSString*)encryptionAlgorithm;
- (void)setEncryptionAlgorithm :(NSString*)newEncryptionAlgorithm;

Default Value

"AES256"

Remarks

Use this property to specify the encryption algorithm to encrypt the PDF document with.

Supported values:

SB_SYMMETRIC_ALGORITHM_RC4RC4
SB_SYMMETRIC_ALGORITHM_AES128AES128
SB_SYMMETRIC_ALGORITHM_AES256AES256

EncryptionCertificate Property (PDFEncryptor Module)

The encryption certificate.

Syntax

public var encryptionCertificate: Certificate {

get {...}
set {...} }

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

- (NSData*)encryptionCertificateBytes;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateCA,setter=setEncryptionCertificateCA:) BOOL encryptionCertificateCA;

- (BOOL)encryptionCertificateCA;
- (void)setEncryptionCertificateCA :(BOOL)newEncryptionCertificateCA;

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

- (NSData*)encryptionCertificateCAKeyID;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateCRLDistributionPoints,setter=setEncryptionCertificateCRLDistributionPoints:) NSString* encryptionCertificateCRLDistributionPoints;

- (NSString*)encryptionCertificateCRLDistributionPoints;
- (void)setEncryptionCertificateCRLDistributionPoints :(NSString*)newEncryptionCertificateCRLDistributionPoints;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateCurve,setter=setEncryptionCertificateCurve:) NSString* encryptionCertificateCurve;

- (NSString*)encryptionCertificateCurve;
- (void)setEncryptionCertificateCurve :(NSString*)newEncryptionCertificateCurve;

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

- (NSData*)encryptionCertificateFingerprint;

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

- (NSString*)encryptionCertificateFriendlyName;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateHandle,setter=setEncryptionCertificateHandle:) long long encryptionCertificateHandle;

- (long long)encryptionCertificateHandle;
- (void)setEncryptionCertificateHandle :(long long)newEncryptionCertificateHandle;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateHashAlgorithm,setter=setEncryptionCertificateHashAlgorithm:) NSString* encryptionCertificateHashAlgorithm;

- (NSString*)encryptionCertificateHashAlgorithm;
- (void)setEncryptionCertificateHashAlgorithm :(NSString*)newEncryptionCertificateHashAlgorithm;

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

- (NSString*)encryptionCertificateIssuer;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateIssuerRDN,setter=setEncryptionCertificateIssuerRDN:) NSString* encryptionCertificateIssuerRDN;

- (NSString*)encryptionCertificateIssuerRDN;
- (void)setEncryptionCertificateIssuerRDN :(NSString*)newEncryptionCertificateIssuerRDN;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateKeyAlgorithm,setter=setEncryptionCertificateKeyAlgorithm:) NSString* encryptionCertificateKeyAlgorithm;

- (NSString*)encryptionCertificateKeyAlgorithm;
- (void)setEncryptionCertificateKeyAlgorithm :(NSString*)newEncryptionCertificateKeyAlgorithm;

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

- (int)encryptionCertificateKeyBits;

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

- (NSData*)encryptionCertificateKeyFingerprint;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateKeyUsage,setter=setEncryptionCertificateKeyUsage:) int encryptionCertificateKeyUsage;

- (int)encryptionCertificateKeyUsage;
- (void)setEncryptionCertificateKeyUsage :(int)newEncryptionCertificateKeyUsage;

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

- (BOOL)encryptionCertificateKeyValid;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateOCSPLocations,setter=setEncryptionCertificateOCSPLocations:) NSString* encryptionCertificateOCSPLocations;

- (NSString*)encryptionCertificateOCSPLocations;
- (void)setEncryptionCertificateOCSPLocations :(NSString*)newEncryptionCertificateOCSPLocations;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateOCSPNoCheck,setter=setEncryptionCertificateOCSPNoCheck:) BOOL encryptionCertificateOCSPNoCheck;

- (BOOL)encryptionCertificateOCSPNoCheck;
- (void)setEncryptionCertificateOCSPNoCheck :(BOOL)newEncryptionCertificateOCSPNoCheck;

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

- (int)encryptionCertificateOrigin;

@property (nonatomic,readwrite,assign,getter=encryptionCertificatePolicyIDs,setter=setEncryptionCertificatePolicyIDs:) NSString* encryptionCertificatePolicyIDs;

- (NSString*)encryptionCertificatePolicyIDs;
- (void)setEncryptionCertificatePolicyIDs :(NSString*)newEncryptionCertificatePolicyIDs;

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

- (NSData*)encryptionCertificatePrivateKeyBytes;

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

- (BOOL)encryptionCertificatePrivateKeyExists;

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

- (BOOL)encryptionCertificatePrivateKeyExtractable;

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

- (NSData*)encryptionCertificatePublicKeyBytes;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateQualifiedStatements,setter=setEncryptionCertificateQualifiedStatements:) int encryptionCertificateQualifiedStatements;

- (int)encryptionCertificateQualifiedStatements;
- (void)setEncryptionCertificateQualifiedStatements :(int)newEncryptionCertificateQualifiedStatements;

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

- (BOOL)encryptionCertificateSelfSigned;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateSerialNumber,setter=setEncryptionCertificateSerialNumber:) NSData* encryptionCertificateSerialNumber;

- (NSData*)encryptionCertificateSerialNumber;
- (void)setEncryptionCertificateSerialNumber :(NSData*)newEncryptionCertificateSerialNumber;

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

- (NSString*)encryptionCertificateSigAlgorithm;

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

- (NSString*)encryptionCertificateSubject;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateSubjectAlternativeName,setter=setEncryptionCertificateSubjectAlternativeName:) NSString* encryptionCertificateSubjectAlternativeName;

- (NSString*)encryptionCertificateSubjectAlternativeName;
- (void)setEncryptionCertificateSubjectAlternativeName :(NSString*)newEncryptionCertificateSubjectAlternativeName;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateSubjectKeyID,setter=setEncryptionCertificateSubjectKeyID:) NSData* encryptionCertificateSubjectKeyID;

- (NSData*)encryptionCertificateSubjectKeyID;
- (void)setEncryptionCertificateSubjectKeyID :(NSData*)newEncryptionCertificateSubjectKeyID;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateSubjectRDN,setter=setEncryptionCertificateSubjectRDN:) NSString* encryptionCertificateSubjectRDN;

- (NSString*)encryptionCertificateSubjectRDN;
- (void)setEncryptionCertificateSubjectRDN :(NSString*)newEncryptionCertificateSubjectRDN;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateValidFrom,setter=setEncryptionCertificateValidFrom:) NSString* encryptionCertificateValidFrom;

- (NSString*)encryptionCertificateValidFrom;
- (void)setEncryptionCertificateValidFrom :(NSString*)newEncryptionCertificateValidFrom;

@property (nonatomic,readwrite,assign,getter=encryptionCertificateValidTo,setter=setEncryptionCertificateValidTo:) NSString* encryptionCertificateValidTo;

- (NSString*)encryptionCertificateValidTo;
- (void)setEncryptionCertificateValidTo :(NSString*)newEncryptionCertificateValidTo;

 

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different to OwnerPassword, most implementations use the same value for the both.

EncryptionCertificates Property (PDFEncryptor Module)

The encryption certificates.

Syntax

public var encryptionCertificates: Array<Certificate> {

get {...} }

@property (nonatomic,readwrite,assign,getter=encryptionCertCount,setter=setEncryptionCertCount:) int encryptionCertCount;

- (int)encryptionCertCount;
- (void)setEncryptionCertCount :(int)newEncryptionCertCount;

- (NSData*)encryptionCertBytes:(int)encryptionCertIndex;

- (BOOL)encryptionCertCA:(int)encryptionCertIndex;
- (void)setEncryptionCertCA:(int)encryptionCertIndex :(BOOL)newEncryptionCertCA;

- (NSData*)encryptionCertCAKeyID:(int)encryptionCertIndex;

- (NSString*)encryptionCertCRLDistributionPoints:(int)encryptionCertIndex;
- (void)setEncryptionCertCRLDistributionPoints:(int)encryptionCertIndex :(NSString*)newEncryptionCertCRLDistributionPoints;

- (NSString*)encryptionCertCurve:(int)encryptionCertIndex;
- (void)setEncryptionCertCurve:(int)encryptionCertIndex :(NSString*)newEncryptionCertCurve;

- (NSData*)encryptionCertFingerprint:(int)encryptionCertIndex;

- (NSString*)encryptionCertFriendlyName:(int)encryptionCertIndex;

- (long long)encryptionCertHandle:(int)encryptionCertIndex;
- (void)setEncryptionCertHandle:(int)encryptionCertIndex :(long long)newEncryptionCertHandle;

- (NSString*)encryptionCertHashAlgorithm:(int)encryptionCertIndex;
- (void)setEncryptionCertHashAlgorithm:(int)encryptionCertIndex :(NSString*)newEncryptionCertHashAlgorithm;

- (NSString*)encryptionCertIssuer:(int)encryptionCertIndex;

- (NSString*)encryptionCertIssuerRDN:(int)encryptionCertIndex;
- (void)setEncryptionCertIssuerRDN:(int)encryptionCertIndex :(NSString*)newEncryptionCertIssuerRDN;

- (NSString*)encryptionCertKeyAlgorithm:(int)encryptionCertIndex;
- (void)setEncryptionCertKeyAlgorithm:(int)encryptionCertIndex :(NSString*)newEncryptionCertKeyAlgorithm;

- (int)encryptionCertKeyBits:(int)encryptionCertIndex;

- (NSData*)encryptionCertKeyFingerprint:(int)encryptionCertIndex;

- (int)encryptionCertKeyUsage:(int)encryptionCertIndex;
- (void)setEncryptionCertKeyUsage:(int)encryptionCertIndex :(int)newEncryptionCertKeyUsage;

- (BOOL)encryptionCertKeyValid:(int)encryptionCertIndex;

- (NSString*)encryptionCertOCSPLocations:(int)encryptionCertIndex;
- (void)setEncryptionCertOCSPLocations:(int)encryptionCertIndex :(NSString*)newEncryptionCertOCSPLocations;

- (BOOL)encryptionCertOCSPNoCheck:(int)encryptionCertIndex;
- (void)setEncryptionCertOCSPNoCheck:(int)encryptionCertIndex :(BOOL)newEncryptionCertOCSPNoCheck;

- (int)encryptionCertOrigin:(int)encryptionCertIndex;

- (NSString*)encryptionCertPolicyIDs:(int)encryptionCertIndex;
- (void)setEncryptionCertPolicyIDs:(int)encryptionCertIndex :(NSString*)newEncryptionCertPolicyIDs;

- (NSData*)encryptionCertPrivateKeyBytes:(int)encryptionCertIndex;

- (BOOL)encryptionCertPrivateKeyExists:(int)encryptionCertIndex;

- (BOOL)encryptionCertPrivateKeyExtractable:(int)encryptionCertIndex;

- (NSData*)encryptionCertPublicKeyBytes:(int)encryptionCertIndex;

- (int)encryptionCertQualifiedStatements:(int)encryptionCertIndex;
- (void)setEncryptionCertQualifiedStatements:(int)encryptionCertIndex :(int)newEncryptionCertQualifiedStatements;

- (BOOL)encryptionCertSelfSigned:(int)encryptionCertIndex;

- (NSData*)encryptionCertSerialNumber:(int)encryptionCertIndex;
- (void)setEncryptionCertSerialNumber:(int)encryptionCertIndex :(NSData*)newEncryptionCertSerialNumber;

- (NSString*)encryptionCertSigAlgorithm:(int)encryptionCertIndex;

- (NSString*)encryptionCertSubject:(int)encryptionCertIndex;

- (NSString*)encryptionCertSubjectAlternativeName:(int)encryptionCertIndex;
- (void)setEncryptionCertSubjectAlternativeName:(int)encryptionCertIndex :(NSString*)newEncryptionCertSubjectAlternativeName;

- (NSData*)encryptionCertSubjectKeyID:(int)encryptionCertIndex;
- (void)setEncryptionCertSubjectKeyID:(int)encryptionCertIndex :(NSData*)newEncryptionCertSubjectKeyID;

- (NSString*)encryptionCertSubjectRDN:(int)encryptionCertIndex;
- (void)setEncryptionCertSubjectRDN:(int)encryptionCertIndex :(NSString*)newEncryptionCertSubjectRDN;

- (NSString*)encryptionCertValidFrom:(int)encryptionCertIndex;
- (void)setEncryptionCertValidFrom:(int)encryptionCertIndex :(NSString*)newEncryptionCertValidFrom;

- (NSString*)encryptionCertValidTo:(int)encryptionCertIndex;
- (void)setEncryptionCertValidTo:(int)encryptionCertIndex :(NSString*)newEncryptionCertValidTo;

 

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different to OwnerPassword, most implementations use the same value for the both.

EncryptionType Property (PDFEncryptor Module)

The encryption type.

Syntax

public var encryptionType: PdfencryptorEncryptionTypes {

get {...}
set {...} }

public enum PdfencryptorEncryptionTypes: Int32 { case petPassword = 1 case petCertificate = 2 }

@property (nonatomic,readwrite,assign,getter=encryptionType,setter=setEncryptionType:) int encryptionType;

- (int)encryptionType;
- (void)setEncryptionType :(int)newEncryptionType;

Default Value

1

Remarks

Use this property to specify the encryption type to use.

Supported values:

petPassword1Encrypt the document with passwords. Use OwnerPassword and UserPassword properties to set the passwords.
petCertificate2Encrypt the document with a certificate. Use EncryptionCertificate or EncryptionCertificates to supply the certificate(s).

EncryptMetadata Property (PDFEncryptor Module)

Specifies whether to encrypt the document metadata.

Syntax

public var encryptMetadata: Bool {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=encryptMetadata,setter=setEncryptMetadata:) BOOL encryptMetadata;

- (BOOL)encryptMetadata;
- (void)setEncryptMetadata :(BOOL)newEncryptMetadata;

Default Value

True

Remarks

Use this property to enable or disable metadata encryption.

Metadata contains additional information about the document, such as its name and author.

FIPSMode Property (PDFEncryptor 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 (PDFEncryptor Module)

Use this property to pass the input to module in the 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 (PDFEncryptor Module)

The PDF file to be encrypted.

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

Provide the path to the PDF document to be encrypted.

OutputBytes Property (PDFEncryptor 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 is completed to read the produced output. This property will only be set if OutputFile and OutputStream properties had not been assigned.

This property is read-only.

OutputFile Property (PDFEncryptor Module)

The file to save the encrypted document to.

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

Specifies the path where the encrypted PDF should be saved.

OwnerPassword Property (PDFEncryptor Module)

The owner password.

Syntax

public var ownerPassword: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=ownerPassword,setter=setOwnerPassword:) NSString* ownerPassword;

- (NSString*)ownerPassword;
- (void)setOwnerPassword :(NSString*)newOwnerPassword;

Default Value

""

Remarks

Use this property to provide the document owner password. Though it may be different to UserPassword, most implementations use the same value for the both.

Permissions Property (PDFEncryptor Module)

Specifies the document permissions associated with the encryption.

Syntax

public var permissions: PDFPermissions {

get {...} }

@property (nonatomic,readwrite,assign,getter=permsAnnotations,setter=setPermsAnnotations:) BOOL permsAnnotations;

- (BOOL)permsAnnotations;
- (void)setPermsAnnotations :(BOOL)newPermsAnnotations;

@property (nonatomic,readwrite,assign,getter=permsAssemble,setter=setPermsAssemble:) BOOL permsAssemble;

- (BOOL)permsAssemble;
- (void)setPermsAssemble :(BOOL)newPermsAssemble;

@property (nonatomic,readwrite,assign,getter=permsExtract,setter=setPermsExtract:) BOOL permsExtract;

- (BOOL)permsExtract;
- (void)setPermsExtract :(BOOL)newPermsExtract;

@property (nonatomic,readwrite,assign,getter=permsExtractAcc,setter=setPermsExtractAcc:) BOOL permsExtractAcc;

- (BOOL)permsExtractAcc;
- (void)setPermsExtractAcc :(BOOL)newPermsExtractAcc;

@property (nonatomic,readwrite,assign,getter=permsFillInForms,setter=setPermsFillInForms:) BOOL permsFillInForms;

- (BOOL)permsFillInForms;
- (void)setPermsFillInForms :(BOOL)newPermsFillInForms;

@property (nonatomic,readwrite,assign,getter=permsHighQualityPrint,setter=setPermsHighQualityPrint:) BOOL permsHighQualityPrint;

- (BOOL)permsHighQualityPrint;
- (void)setPermsHighQualityPrint :(BOOL)newPermsHighQualityPrint;

@property (nonatomic,readwrite,assign,getter=permsLowQualityPrint,setter=setPermsLowQualityPrint:) BOOL permsLowQualityPrint;

- (BOOL)permsLowQualityPrint;
- (void)setPermsLowQualityPrint :(BOOL)newPermsLowQualityPrint;

@property (nonatomic,readwrite,assign,getter=permsModify,setter=setPermsModify:) BOOL permsModify;

- (BOOL)permsModify;
- (void)setPermsModify :(BOOL)newPermsModify;

 

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different to OwnerPassword, most implementations use the same value for the both.

UserPassword Property (PDFEncryptor Module)

The user password.

Syntax

public var userPassword: String {

get {...}
set {...} }

@property (nonatomic,readwrite,assign,getter=userPassword,setter=setUserPassword:) NSString* userPassword;

- (NSString*)userPassword;
- (void)setUserPassword :(NSString*)newUserPassword;

Default Value

""

Remarks

Use this property to provide the document user password. Though it may be different to OwnerPassword, most implementations use the same value for the both.

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

DoAction Method (PDFEncryptor 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 of the action is provided in ActionID parameter. ActionParams contains a list of parameters for the action in the form of PARAM1=VALUE1;PARAM2=VALUE2;....

Encrypt Method (PDFEncryptor Module)

Encrypts the PDF document.

Syntax

public func encrypt() throws -> Void
- (void)encrypt;

Remarks

Use this method to encrypt the PDF document as configured in the object's properties.

Error Event (PDFEncryptor Module)

Information about errors during encryption.

Syntax

func onError(errorCode: Int32, description: String)
- (void)onError:(int)errorCode :(NSString*)description;

Remarks

The event is fired in case of exceptional conditions during PDF processing.

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

Notification Event (PDFEncryptor 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 component. For example, it may fire to report completion of the document processing. The list of events being reported is not fixed, and may be flexibly extended over time.

The unique identifier of the event is provided in EventID parameter. EventParam contains any parameters accompanying the occurrence. Depending on the type of the component, the exact action it is performing, or the document being processed, one or both may be omitted.

Certificate Type

Provides details of an individual X.509 certificate.

Remarks

This type provides access to X.509 certificate details.

Fields

bytes
Data

Returns raw certificate data in DER format.

ca
Bool

Indicates whether the certificate has a CA capability (a setting in BasicConstraints extension).

caKeyID
Data

A unique identifier (fingerprint) of the CA certificate's private key.

Authority Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates produced by the same issuer, but with different public keys.

crlDistributionPoints
String

Locations of the CRL (Certificate Revocation List) distribution points used to check this certificate's validity.

curve
String

Specifies the elliptic curve of the EC public key.

SB_EC_SECP112R1SECP112R1
SB_EC_SECP112R2SECP112R2
SB_EC_SECP128R1SECP128R1
SB_EC_SECP128R2SECP128R2
SB_EC_SECP160K1SECP160K1
SB_EC_SECP160R1SECP160R1
SB_EC_SECP160R2SECP160R2
SB_EC_SECP192K1SECP192K1
SB_EC_SECP192R1SECP192R1
SB_EC_SECP224K1SECP224K1
SB_EC_SECP224R1SECP224R1
SB_EC_SECP256K1SECP256K1
SB_EC_SECP256R1SECP256R1
SB_EC_SECP384R1SECP384R1
SB_EC_SECP521R1SECP521R1
SB_EC_SECT113R1SECT113R1
SB_EC_SECT113R2SECT113R2
SB_EC_SECT131R1SECT131R1
SB_EC_SECT131R2SECT131R2
SB_EC_SECT163K1SECT163K1
SB_EC_SECT163R1SECT163R1
SB_EC_SECT163R2SECT163R2
SB_EC_SECT193R1SECT193R1
SB_EC_SECT193R2SECT193R2
SB_EC_SECT233K1SECT233K1
SB_EC_SECT233R1SECT233R1
SB_EC_SECT239K1SECT239K1
SB_EC_SECT283K1SECT283K1
SB_EC_SECT283R1SECT283R1
SB_EC_SECT409K1SECT409K1
SB_EC_SECT409R1SECT409R1
SB_EC_SECT571K1SECT571K1
SB_EC_SECT571R1SECT571R1
SB_EC_PRIME192V1PRIME192V1
SB_EC_PRIME192V2PRIME192V2
SB_EC_PRIME192V3PRIME192V3
SB_EC_PRIME239V1PRIME239V1
SB_EC_PRIME239V2PRIME239V2
SB_EC_PRIME239V3PRIME239V3
SB_EC_PRIME256V1PRIME256V1
SB_EC_C2PNB163V1C2PNB163V1
SB_EC_C2PNB163V2C2PNB163V2
SB_EC_C2PNB163V3C2PNB163V3
SB_EC_C2PNB176W1C2PNB176W1
SB_EC_C2TNB191V1C2TNB191V1
SB_EC_C2TNB191V2C2TNB191V2
SB_EC_C2TNB191V3C2TNB191V3
SB_EC_C2ONB191V4C2ONB191V4
SB_EC_C2ONB191V5C2ONB191V5
SB_EC_C2PNB208W1C2PNB208W1
SB_EC_C2TNB239V1C2TNB239V1
SB_EC_C2TNB239V2C2TNB239V2
SB_EC_C2TNB239V3C2TNB239V3
SB_EC_C2ONB239V4C2ONB239V4
SB_EC_C2ONB239V5C2ONB239V5
SB_EC_C2PNB272W1C2PNB272W1
SB_EC_C2PNB304W1C2PNB304W1
SB_EC_C2TNB359V1C2TNB359V1
SB_EC_C2PNB368W1C2PNB368W1
SB_EC_C2TNB431R1C2TNB431R1
SB_EC_NISTP192NISTP192
SB_EC_NISTP224NISTP224
SB_EC_NISTP256NISTP256
SB_EC_NISTP384NISTP384
SB_EC_NISTP521NISTP521
SB_EC_NISTB163NISTB163
SB_EC_NISTB233NISTB233
SB_EC_NISTB283NISTB283
SB_EC_NISTB409NISTB409
SB_EC_NISTB571NISTB571
SB_EC_NISTK163NISTK163
SB_EC_NISTK233NISTK233
SB_EC_NISTK283NISTK283
SB_EC_NISTK409NISTK409
SB_EC_NISTK571NISTK571
SB_EC_GOSTCPTESTGOSTCPTEST
SB_EC_GOSTCPAGOSTCPA
SB_EC_GOSTCPBGOSTCPB
SB_EC_GOSTCPCGOSTCPC
SB_EC_GOSTCPXCHAGOSTCPXCHA
SB_EC_GOSTCPXCHBGOSTCPXCHB
SB_EC_BRAINPOOLP160R1BRAINPOOLP160R1
SB_EC_BRAINPOOLP160T1BRAINPOOLP160T1
SB_EC_BRAINPOOLP192R1BRAINPOOLP192R1
SB_EC_BRAINPOOLP192T1BRAINPOOLP192T1
SB_EC_BRAINPOOLP224R1BRAINPOOLP224R1
SB_EC_BRAINPOOLP224T1BRAINPOOLP224T1
SB_EC_BRAINPOOLP256R1BRAINPOOLP256R1
SB_EC_BRAINPOOLP256T1BRAINPOOLP256T1
SB_EC_BRAINPOOLP320R1BRAINPOOLP320R1
SB_EC_BRAINPOOLP320T1BRAINPOOLP320T1
SB_EC_BRAINPOOLP384R1BRAINPOOLP384R1
SB_EC_BRAINPOOLP384T1BRAINPOOLP384T1
SB_EC_BRAINPOOLP512R1BRAINPOOLP512R1
SB_EC_BRAINPOOLP512T1BRAINPOOLP512T1
SB_EC_CURVE25519CURVE25519
SB_EC_CURVE448CURVE448

fingerprint
Data

Contains the fingerprint (a hash imprint) of this certificate.

friendlyName
String

Contains an associated alias (friendly name) of the certificate.

handle
Int64

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

Specifies the hash algorithm to be used in the operations on the certificate (such as key signing)

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

issuer
String

The common name of the certificate issuer (CA), typically a company name.

issuerRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate issuer.

keyAlgorithm
String

Specifies the public key algorithm of this certificate.

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

keyBits
Int32

Returns the length of the public key.

keyFingerprint
Data

Returns a fingerprint of the public key contained in the certificate.

keyUsage
Int32

Indicates the purposes of the key contained in the certificate, in the form of an OR'ed flag set.

This value is a bit mask of the following values:

ckuUnknown0x00000Unknown key usage

ckuDigitalSignature0x00001Digital signature

ckuNonRepudiation0x00002Non-repudiation

ckuKeyEncipherment0x00004Key encipherment

ckuDataEncipherment0x00008Data encipherment

ckuKeyAgreement0x00010Key agreement

ckuKeyCertSign0x00020Certificate signing

ckuCRLSign0x00040Revocation signing

ckuEncipherOnly0x00080Encipher only

ckuDecipherOnly0x00100Decipher only

ckuServerAuthentication0x00200Server authentication

ckuClientAuthentication0x00400Client authentication

ckuCodeSigning0x00800Code signing

ckuEmailProtection0x01000Email protection

ckuTimeStamping0x02000Timestamping

ckuOCSPSigning0x04000OCSP signing

ckuSmartCardLogon0x08000Smartcard logon

ckuKeyPurposeClientAuth0x10000Kerberos - client authentication

ckuKeyPurposeKDC0x20000Kerberos - KDC

keyValid
Bool

Returns True if the certificate's key is cryptographically valid, and False otherwise.

ocspLocations
String

Locations of OCSP (Online Certificate Status Protocol) services that can be used to check this certificate's validity, as recorded by the CA.

ocspNoCheck
Bool

TBD.

origin
Int32

Returns the origin of this certificate.

policyIDs
String

Contains identifiers (OIDs) of the applicable certificate policies.

The Certificate Policies extension identifies a sequence of policies under which the certificate has been issued, and which regulate its usage.

privateKeyBytes
Data

Contains the certificate's private key. It is normal for this property to be empty if the private key is non-exportable.

privateKeyExists
Bool

Indicates whether the certificate has an associated private key.

privateKeyExtractable
Bool

Indicates whether the private key is extractable

publicKeyBytes
Data

Contains the certificate's public key in DER format.

qualifiedStatements
QualifiedStatementsTypes

TBD

selfSigned
Bool

Indicates whether the certificate is self-signed (root) or signed by an external CA.

serialNumber
Data

Returns the certificate's serial number.

sigAlgorithm
String

Indicates the algorithm that was used by the CA to sign this certificate.

subject
String

The common name of the certificate holder, typically an individual's name, a URL, an e-mail address, or a company name.

subjectAlternativeName
String

TBD.

subjectKeyID
Data

Contains a unique identifier (fingerprint) of the certificate's private key.

Subject Key Identifier is a (non-critical) X.509 certificate extension which allows the identification of certificates containing a particular public key. In SecureBlackbox, the unique identifier is represented with a SHA1 hash of the bit string of the subject public key.

subjectRDN
String

A collection of information, in the form of [OID, Value] pairs, uniquely identifying the certificate holder (subject).

validFrom
String

The time point at which the certificate becomes valid, in UTC.

validTo
String

The time point at which the certificate expires, in UTC.

Constructors

public init(stream: InputStream?)

Loads the X.509 certificate from a stream. Stream is a stream containing the certificate data.

public init()

Creates a new object with default field values.

PDFPermissions Type

Contains information about the permissions the viewing app gets over the encrypted document.

Remarks

Document encryption carries an associated permission directory with it. Use the permissions directory to suggest the viewing application the operations it is allowed to perform on the document.

Fields

annotations
Bool

Indicates whether the viewer may add annotations to the document.

assemble
Bool

Indicates if the viewer may assemble a new document on the basis of the encrypted one.

extract
Bool

Indicates if the user may extract (copy) pictures and text from the encrypted document.

extractAcc
Bool

Indicates if the user may extract pictures/text from the document for accessibility purposes.

fillInForms
Bool

Indicates if the user may fill in forms in the document.

highQualityPrint
Bool

Indicates if the document may be printed in high quality.

lowQualityPrint
Bool

Indicates if the document may be printed in low quality.

modify
Bool

Indicates if the document may be modified.

Constructors

public init()

Initializes an instance of PDFPermissions class.

Configuration Settings (PDFEncryptor 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.

PDFEncryptor Configuration Settings

EncryptionHandlerName:   Specifies the custom security handler PDF-name.

Specifies the custom security handler PDF-name for encryption handler.

HardenedKeyGeneration:   Specifies if hardened Key generation should be used.

Specifies if hardened Key generation should be used when an AES-256 encryption algorithm and password encryption are used.

RC4KeyBits:   Specifies the number of key bits used for RC4 algorithm.

Specifies the number of key bits used for RC4 encryption algorithm.

TempPath:   Location where the temporary files are stored.

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

Base Configuration 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 (supported for HTTPClient, RESTClient and SOAPClient only)
globalGlobal caching

Cookies:   Gets or sets local cookies for the class (supported for HTTPClient, RESTClient and SOAPClient only).

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.

Tag:   Allows to store any custom data.

Use this config property to store any custom data.

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

PDFEncryptor 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) 
26214401   Input file does not exist (SB_ERROR_PDF_INPUTFILE_NOT_EXISTS)
26214402   Document is encrypted (SB_ERROR_PDF_ENCRYPTED)
26214403   Document not encrypted (SB_ERROR_PDF_NOT_ENCRYPTED)
26214404   Unknown certificate type (SB_ERROR_PDF_UNKNOWN_ENCRYPTION_TYPE)
26214405   Invalid password (SB_ERROR_PDF_INVALID_PASSWORD)
26214406   Decryption failed (SB_ERROR_PDF_DECRYPTION_FAILED)
26214407   Document is signed (SB_ERROR_PDF_SIGNED)
26214408   Document is not signed (SB_ERROR_PDF_NOT_SIGNED)
26214409   Inappropriate signature (SB_ERROR_PDF_INAPPROPRIATE_SIGNATURE)
26214410   Not supported (SB_ERROR_PDF_NOT_SUPPORTED)

Copyright (c) 2022 /n software inc. - All rights reserved.
SecureBlackbox 2022 macOS Edition - Version 22.0 [Build 8174]