StandardSecurityHandlerRev4

DsPdfJS API / StandardSecurityHandlerRev4

Class: StandardSecurityHandlerRev4

Represents Standard Security Handler Revision 4. This handler supports RC4 encryption with 40�128-bit keys or AES encryption with a 128-bit key, and allows defining additional permission flags.

Extends

StandardSecurityHandlerRev3

Extended by

StandardSecurityHandlerRev5

Accessors

accessType

Get Signature

get accessType(): AccessType | null

Gets the access type granted by this StandardSecurityHandler, or null. This property is initialized when a document is loaded.

Returns

AccessType | null

Inherited from

StandardSecurityHandlerRev3.accessType

allowCopyContent

Get Signature

get allowCopyContent(): boolean

Gets or sets whether the user can copy contents from the PDF document.

Returns

boolean

Set Signature

set allowCopyContent(value): void

Gets or sets whether the user can copy contents from the PDF document.

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.allowCopyContent

allowEditAnnotations

Get Signature

get allowEditAnnotations(): boolean

Gets or sets whether the user can edit annotations in the PDF document.

Returns

boolean

Set Signature

set allowEditAnnotations(value): void

Gets or sets whether the user can edit annotations in the PDF document.

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.allowEditAnnotations

allowEditContent

Get Signature

get allowEditContent(): boolean

Gets or sets whether the user can edit the contents of the PDF document.

Returns

boolean

Set Signature

set allowEditContent(value): void

Gets or sets whether the user can edit the contents of the PDF document.

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.allowEditContent

allowPrint

Get Signature

get allowPrint(): boolean

Gets or sets whether the user can print the PDF document.

Returns

boolean

Set Signature

set allowPrint(value): void

Gets or sets whether the user can print the PDF document.

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.allowPrint

copyContent

Get Signature

get copyContent(): boolean

Gets or sets a value indicating whether a document's content can be copied or extracted.

Returns

boolean

Set Signature

set copyContent(value): void

Gets or sets a value indicating whether a document's content can be copied or extracted.

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.copyContent

copyContentAccessibility

Get Signature

get copyContentAccessibility(): boolean

Gets or sets a value used to determine whether content could be extracted for the purposes of accessibility. Note however that this restriction has been deprecated in PDF 2.0, which states that PDF readers shall ignore this bit. The default value of this property is true, and it should not be changed.

Returns

boolean

Set Signature

set copyContentAccessibility(value): void

Parameters

value

boolean

Returns

void

Inherited from

StandardSecurityHandlerRev3.copyContentAccessibility

editingPermissions

Get Signature

get editingPermissions(): EditingPermissions

Gets or sets a value controlling how a document can be edited.

Returns

EditingPermissions

Set Signature

set editingPermissions(value): void

Gets or sets a value controlling how a document can be edited.

Parameters

value

EditingPermissions

Returns

void

Inherited from

StandardSecurityHandlerRev3.editingPermissions

encryptionAlgorithm

Get Signature

get encryptionAlgorithm(): number

Gets or sets a value indicating whether streams should be encrypted.

Returns

number

Set Signature

set encryptionAlgorithm(value): void

Gets or sets a value indicating whether streams should be encrypted.

Parameters

value

number

Returns

void

encryptionKeyLength

Get Signature

get encryptionKeyLength(): number

Gets or sets the length of the encryption key, in bits. The value must be a multiple of 8, in the range from 40 to 128. IMPORTANT NOTE: StandardSecurityHandlerRev4 can use RC4 or AES encryption, and according to specification, with RC4 any key length in the range from 40 to 128 can be used. But tests show that current/recent versions of Adobe Acrobat Reader DC and Adobe Acrobat Pro DC cannot handle files encrypted with RC4 if the key length is not equal to 128. Older versions of Acrobat Reader handle such files without issues, so it looks like a bug in the newer versions of Acrobat Reader. So it is recommended that StandardSecurityHandlerRev3 is used in cases when RC4 encryption with key length other than 128 is required.

Returns

number

Set Signature

set encryptionKeyLength(value): void

Parameters

value

number

Returns

void

Inherited from

StandardSecurityHandlerRev3.encryptionKeyLength

encryptMetadata

Get Signature

get encryptMetadata(): boolean

Gets or sets a value indicating whether the document-level metadata stream is to be encrypted.

Returns

boolean

Set Signature

set encryptMetadata(value): void

Gets or sets a value indicating whether the document-level metadata stream is to be encrypted.

Parameters

value

boolean

Returns

void

encryptStreams

Get Signature

get encryptStreams(): boolean

Gets or sets a value indicating whether streams should be encrypted.

Returns

boolean

Set Signature

set encryptStreams(value): void

Gets or sets a value indicating whether streams should be encrypted.

Parameters

value

boolean

Returns

void

encryptStrings

Get Signature

get encryptStrings(): boolean

Gets or sets a value indicating whether strings should be encrypted.

Returns

boolean

Set Signature

set encryptStrings(value): void

Gets or sets a value indicating whether strings should be encrypted.

Parameters

value

boolean

Returns

void

id

Get Signature

get id(): number

Gets the reference to the object.

Returns

number

Inherited from

StandardSecurityHandlerRev3.id

om

Get Signature

get om(): ObjectManager

Gets the owner ObjectManager instance.

Returns

ObjectManager

Inherited from

StandardSecurityHandlerRev3.om

ownerPassword

Get Signature

get ownerPassword(): string

Gets or sets the password required to change permissions of a PDF document as a string. The two properties ownerPassword and ownerPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.

Returns

string

Set Signature

set ownerPassword(value): void

Parameters

value

string

Returns

void

Inherited from

StandardSecurityHandlerRev3.ownerPassword

ownerPasswordBytes

Get Signature

get ownerPasswordBytes(): Uint8Array

Gets or sets the password required to change permissions of a PDF document as a byte array. The two properties ownerPassword and ownerPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.

Returns

Uint8Array

Set Signature

set ownerPasswordBytes(value): void

Parameters

value

Uint8Array

Returns

void

Inherited from

StandardSecurityHandlerRev3.ownerPasswordBytes

passwordMatches

Get Signature

get passwordMatches(): PasswordMatches

Gets a combination of flags that indicate how the password specified when loading the PDF matches the document's User and Owner passwords.

Returns

PasswordMatches

Inherited from

StandardSecurityHandlerRev3.passwordMatches

printingPermissions

Get Signature

get printingPermissions(): PrintingPermissions

Gets or sets a value controlling how a document can be printed.

Returns

PrintingPermissions

Set Signature

set printingPermissions(value): void

Gets or sets a value controlling how a document can be printed.

Parameters

value

PrintingPermissions

Returns

void

Inherited from

StandardSecurityHandlerRev3.printingPermissions

revision

Get Signature

get revision(): number

Gets the revision of this StandardSecurityHandler.

Returns

number

Inherited from

StandardSecurityHandlerRev3.revision

userPassword

Get Signature

get userPassword(): string

Gets or sets the password required to open a PDF document as a string. The two properties userPassword and userPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdf cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using userPasswordBytes.

Returns

string

Set Signature

set userPassword(value): void

Parameters

value

string

Returns

void

Inherited from

StandardSecurityHandlerRev3.userPassword

userPasswordBytes

Get Signature

get userPasswordBytes(): Uint8Array

Gets or sets the password required to open a PDF document as a byte array. The two properties userPassword and userPasswordBytes allow to define the password as a string or as an array of bytes. According to the PDF specification, a string password should be converted to an array of bytes using the system code page (if the standard security handler with revision 4 or less is used). In some environments the system code page is unavailable, so DsPdfJS cannot perform this conversion. If the password string only contains ASCII chars, this does not present a problem. But if the password string contains non-ASCII Unicode characters, it is up to the developer to perform the conversion and set the password using this property.