Introduction to PDF SDK for Web Permissions

Note: The user permissions in both web viewer and PDF document level follow the same rules specified in PDF References. All the permissions and bit positions have the same meaning. For details, see Supported User Permissions.

Document User Permissions

In the PDF standard, you can set the user permissions for PDF documents. In Web Viewer, you can set password, user permissions and encryption algorithm by using the method PDFDoc. SetPasswordAndPermission () .

Sample: The following example code sets the password and permissions for the current document.

pdfdoc.setPasswordAndPermission('userPassword','ownerPassword', 0b111100, 'aes25', true);

Doc User Permissions Graph
When loading a document, you can get document user permissions by using the method PDFDoc.getUserPermissions() or PDFDoc.getPermissions().

PDFDoc.getUserPermissions()：This method checks only the specified document user restricted permissions.

PDFDoc.getPermissions()： This method checks the specified document user permissions including user and owner. If you are the owner, it returns all permission, otherwise, it returns the same value of PDFDoc.getUserPermissions().

When you want to check what permissions you currently have set for the document, you can use the methods supported on the class UserPermission. For specific methods, refer to PDFViewCtrl.UserPermission.

UserPermission：A class used to facilitate you to check user permissions.

Sample: The following sample code shows how to open a document with user and owner password protection, and get values for the user permissions.

var pdfDoc = pdfViwer.openPDFByFile(file, {password: 'userPassword'}).then(function (pdfDoc) {
pdfDoc.getUserPermissions() === 0b111100;
PDFDoc.getPermissions() === 0b111100;
})

var pdfDoc = pdfViwer.openPDFByFile(file, {password: 'ownerPassword'}).then(function (pdfDoc) {
pdfDoc.getUserPermissions() === 0b111100;
PDFDoc.getPermissions() > 0b111100;
})

Web Viewer User Permissions
The user permissions at document level help you to control the security of your documents. But what if you only want to supervise users on an application level? You can configure the option PDFViewer.options.customs.getDocPermissions on the Web Viewer constructor to set the permissions. When the Web Viewer has finished its initialization, it will take the intersection of the return values (see the image below) from PDFViewer.options.customs.getDocPermissions and PDFDoc.getPermissions() , and then define the final user access permissions on the Web Viewer. If the intersection value is 0, the Web Viewer determines the user access permission is set to read-only.

The following code sets read-only permissions on the constructor by presuming the current document has no user permissions.

Sample 1: By setting values

Tip: The values that can be set are -1 and 0. -1 represents owner permissions, 0 represents read-only.

var PDFUI = UIExtension.PDFUI;
var pdfui = new PDFUI({
viewerOptions: {
libPath: '../../../lib',
jr: {
licenseSN: licenseSN,
licenseKey: licenseKey
}
customs: {
getDocPermissions: function (pdfDoc) {
return 0;
// 0 means read-only 
}
}
},
});

Sample 2：By using the set methods

Currently the supported methods:

putCannotModifyAny() – Permission are set as read-only.

putCannotModifyExcludeAssemble() – Permissions that allow only insert, rotate, or delete pages and create bookmarks or thumbnails。

function example (PDFViewer, UserPermission) {
var pdfViewer = new PDFViewer({
customs: {
getDocPermissions: function (pdfDoc) {
// Set read-only permissions
var userPermission = new UserPermission();
userPermission.putCannotModifyAny();
return userPermission.getValue();
}
}
});

Note: All permissions set at the Web Viewer level will no be written into documents.

When Web Viewer has finished its initialization, you may want to view the configured permissions on constructor and/or the final user access permissions for current document. You can get the permission values by using the following two methods.

UserPermission.getValue(): To get the user permissions on constructor.

PDFDocRender.getUserPermission(): To get the final user permissions for accessing documents.

Custom Web Viewer User Permissions

The Custom Web Viewer here means you customized some components or add-ons pertinent to PDF in Web Viewer. In this scenario, when you configure user permissions on the constructor, you should explicitly call PDFDocRender.getUserPermission() to get the final user permissions to access documents in the viewer.

function example (PDFViewer, UserPermission) {
var pdfViewer = new PDFViewer({
customs: {
getDocPermissions: function (pdfDoc) {
// All users have read-only access only
var userPermission = new UserPermission();
userPermission.putCannotModifyAny();
return (userPermission).getValue();
}
}
});
...
var pdfDocRender = pdfViewer.getPDFDocRender();
if (pdfDocRender) {
pdfDocRender.getUserPermission().then(function (docViewerPermission) {
if (!docViewerPermission.checkPrint()) {
// Print is disallowed
// No subsequent execution
return;
}

})
}
}

Supported User Permissions

PDF References uses 32-bit binary values to specify user access permissions. The supported bit positions include 3, 4, 5, 6, 9, 10, 11, 12. Each bit position has a corresponding access meaning. See the table below for details.

Tip 1: The binary number 0 is interpreted as the corresponding permission ‘disallowed’, and number 1 is ‘allowed’. For example, the 0b100, the 3rd bit position is 1, then the related access permission for print should be enabled.

The following table lists the bit position and its pertinent meaning that are applied to Viewer, Security standard handler and Foxit DRM.

For the bit positions that are not reserved in PDF References, like 1, 2, 7, 8, and 13-32, PDF SDK for Web reserves these positions, and interprets 1,2 as the binary number 0; 7, 8 and 13-32 as the binary number 1. These bit positions won’t affect your project, they are preserved just for future usage when more permissions are specified. For example, 0b11000100, the seventh and eighth position is number 1, they will be ignored in the execution.