Ruby Requires Chilkat v11.7.0+

Change the Passwords of an Encrypted PDF

See more PDF Protection Examples

Demonstrates the changePasswords operation, which gives an encrypted PDF new user and owner passwords and keeps its algorithm and permissions. The PDF is loaded with its current passwords, the two properties are then set to the new ones, and Protection reads them at the time of the call. Both passwords are replaced, so set both: a property left empty becomes an empty password. Ruby

require 'chilkat'

success = false

#  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

pdf = Chilkat::CkPdf.new()

#  Load with the current passwords.
pdf.put_UserPassword("secret")
pdf.put_OwnerPassword("owner-secret")
success = pdf.LoadFile("qa_data/pdf/encrypted_user_password.pdf")
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  The new passwords.  Protection reads the properties as they are when it is called.
pdf.put_UserPassword("new-user-secret")
pdf.put_OwnerPassword("new-owner-secret")

json = Chilkat::CkJsonObject.new()
jsonOut = Chilkat::CkJsonObject.new()
success = pdf.Protection("changePasswords",json,jsonOut)
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  The algorithm and the permissions are kept.
print "algorithm: " + jsonOut.stringOf("pending.algorithm") + "\n";
print "password needed to open: " + jsonOut.BoolOf("pending.userPasswordRequired").to_s() + "\n";

success = pdf.WriteFile("qa_output/minutes_new_passwords.pdf")
if (success == false)
    print pdf.lastErrorText() + "\n";
    exit
end

#  The new user password opens the result.
reader = Chilkat::CkPdf.new()
reader.put_UserPassword("new-user-secret")
success = reader.LoadFile("qa_output/minutes_new_passwords.pdf")
if (success == false)
    print reader.lastErrorText() + "\n";
    exit
end

success = reader.Protection("getInfo",json,jsonOut)
if (success == false)
    print reader.lastErrorText() + "\n";
    exit
end

print "with the new user password, opened with: " + jsonOut.stringOf("loaded.openedWith") + "\n";

#  And so does the new owner password.
owner = Chilkat::CkPdf.new()
owner.put_OwnerPassword("new-owner-secret")
success = owner.LoadFile("qa_output/minutes_new_passwords.pdf")
if (success == false)
    print owner.lastErrorText() + "\n";
    exit
end

success = owner.Protection("getInfo",json,jsonOut)
if (success == false)
    print owner.lastErrorText() + "\n";
    exit
end

print "with the new owner password, opened with: " + jsonOut.stringOf("loaded.openedWith") + "\n";

#  Sample output:

#  algorithm: rc4-128
#  password needed to open: True
#  with the new user password, opened with: user
#  with the new owner password, opened with: owner