Lua Requires Chilkat v11.7.0+

Get the Encryption and Permissions of a Loaded PDF

See more PDF Protection Examples

Demonstrates the getInfo operation of Protection, which reports how the loaded PDF is protected: the method and algorithm, whether a password is needed to open it, how it was opened (with the user password, the owner password, an empty password, or a certificate), and each permission. The loaded member describes the file as it is, the pending member describes the security it will be saved with, and changed says whether the two differ. getInfo is the one operation that does not need owner rights. Lua

local chilkat = require("chilkat")

-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.

-- The PDF used in this example is available at encrypted_user_password.pdf

local pdf = chilkat.Pdf.new()

-- The password must be set before loading.
pdf.user_password = "secret"
local success = pdf:load_file("qa_data/pdf/encrypted_user_password.pdf")
if not success then
    print(pdf.last_error_text)
    return
end

local json = chilkat.JsonObject.new()
local jsonOut = chilkat.JsonObject.new()
success = pdf:protection("getInfo", json, jsonOut)
if not success then
    print(pdf.last_error_text)
    return
end

jsonOut.emit_compact = false
print(jsonOut:emit())

-- "loaded" is the security the file has.  "pending" is the security it will be saved with, which
-- is the same until an operation such as encrypt or changePermissions changes it.
print("algorithm: " .. jsonOut:string_of("loaded.algorithm"))
print("opened with: " .. jsonOut:string_of("loaded.openedWith"))
print("password needed to open: " .. tostring(jsonOut:bool_of("loaded.userPasswordRequired")))
print("may print: " .. jsonOut:string_of("loaded.permissions.print"))
print("may copy: " .. tostring(jsonOut:bool_of("loaded.permissions.copy")))
print("changed: " .. tostring(jsonOut:bool_of("changed")))

-- Sample output:

-- {
--   "changed": false,
--   "loaded": {
--     "encrypted": true,
--     "method": "password",
--     "algorithm": "rc4-128",
--     "pdfVersion": "1.3",
--     "scope": "all",
--     "userPasswordRequired": true,
--     "ownerPasswordSet": true,
--     "openedWith": "user",
--     "permissions": {
--       "print": "full",
--       "modify": true,
--       "copy": true,
--       "accessibility": true,
--       "annotate": true,
--       "fillForms": true,
--       "assemble": true
--     }
--   },
--   "pending": {
--     "encrypted": true,
--     "method": "password",
--     "algorithm": "rc4-128",
--     "pdfVersion": "1.3",
--     "scope": "all",
--     "userPasswordRequired": true,
--     "ownerPasswordSet": true,
--     "permissions": {
--       "print": "full",
--       "modify": true,
--       "copy": true,
--       "accessibility": true,
--       "annotate": true,
--       "fillForms": true,
--       "assemble": true
--     }
--   }
-- }
--
-- algorithm: rc4-128
-- opened with: user
-- password needed to open: True
-- may print: full
-- may copy: True
-- changed: False