EncryptionSettings

EncryptionSettings

This class provides information about the encryption settings of the specified PDF file, such as user and owner passwords, encryption algorithm etc.

Methods

algorithm() → {string}

Description:
  • Returns a string specifying the encryption algorithm used to encrypt the specified PDF file - e.g. "AES" etc.

Returns:

The name of the encryption algorithm used to encrypt the specified PDF file.

Type
string

bitLength() → {number}

Description:
  • Returns the number of bits in the key used by a cryptographic algorithm to encrypt the specified PDF file.

Returns:

The number of bits in the key used by a cryptographic algorithm.

Type
number

isOwnerPasswordSet() → {boolean}

Description:
  • Returns a boolean specifying whether the owner password is set for the specified PDF file.

Returns:

True if the owner password is set for the specified PDF file. False otherwise.

Type
boolean

isUserPasswordSet() → {boolean}

Description:
  • Returns a boolean specifying whether the user password is set for the specified PDF file.

Returns:

True if the user password is set for the specified PDF file. False otherwise.

Type
boolean

onlyAttachmentsEncrypted() → {boolean}

Description:
  • Returns a boolean specifying whether only the file attachments in the specified PDF file are encrypted.

Returns:

True if only the file attachments in the specified PDF file are encrypted. False otherwise.

Type
boolean

isMetadataEncrypted() → {boolean}

Description:
  • Returns a boolean specifying whether the metadata of the specified PDF file is encrypted.

Returns:

True if the metadata of the specified PDF file is encrypted. False otherwise.

Type
boolean