Ensuring your data is protected is our top priority and we’ve implemented a number of security protocols to prevent unauthorised access to PDF documents generated with Gravity PDF. As all PDF rendering is done directly on your web server no third-party PDF service has access to your data either. Win-win!
Once you’ve installed the plugin it’s strongly recommended you review the security settings and thoroughly test they are working correctly.
Default Security #default-security
tl;dr – The default security settings allow the user who submits the entry to view their own PDF. Site Administrators and Network Super Administrators can view all PDFs.
The software ships with conservative defaults that provides a well-balanced mix of PDF access and security. By default, the following users will be able to access PDFs:
- Administrator and Super Administrator users (if running multisite) can access all PDFs.
Any user with a WordPress role that has the
gravityforms_view_entriescapability (by default this is only Administrators and Super Administrators) can access all PDFs. You can change this behaviour by modifying the User Restrictions option in the global settings, or adding the
gravityforms_view_entriescapability to an existing role (use a role editor plugin).
The original Gravity Form entry owner (the end-user who completed the form) can access their PDF. The protocols used to determine if a user is the owner include:
In Gravity Forms 2.2 there was a change to how IP addresses are determined. By default, Gravity Forms will no longer handle proxy-based IP addresses automatically (Cloudflare, Load Balancer and WAF Firewalls are affected). In such cases our IP-based access policy mentioned below will not work. If you are affected you’ll need to use the
gform_ip_addressfilter to return the correct IP address.
- The software will compare the user’s IP address against the one stored with the entry and if they match the PDF will be displayed. Because IP addresses do change, a time-based security measure has also been implemented which only allows logged-out user access to the PDF for 20 minutes by default after submitting the form. This behaviour can be changed using the Logged Out Timeout option in the global settings.
- If the user’s IP doesn’t match, or the 20-minute timeout window has expired, AND the entry owner was originally logged in when completing the form they will be redirected to a login page. Once authenticated, the software will compare the user’s ID with the one stored in the entry. If they match the PDF will be displayed.
- If a user is already logged in we’ll do the user ID comparison without the need to login again.
To correctly test the owner security policy you’ll need to submit a new entry using a web proxy like hide.me so that the IP address differs from your own.
PDFs and the File System #filesystem
tl;dr – PDFs stored on the disk have a limited lifespan, and are protected from direct access on Apache and Litespeed web servers. Other servers aren’t automatically protected and it’s advisable to use the
gfpdf_tmp_locationfilter to change the PDF directory to somewhere outside your public directory structure.
Currently, the only time a PDF is actually saved to disk is when it’s configured to be attached to a form’s notification(s), or the Always Save PDF setting is enabled (use Always Save in conjunction with the
gfpdf_post_save_pdf action to copy PDFs to another directory). By default, these PDFs are saved locally to
/wp-content/uploads/PDF_EXTENDED_TEMPLATES/tmp/ but are cleaned up automatically from the disk once the Gravity Forms submission process has been completed. Any stray documents older than 12 hours are also automatically cleaned up.
Direct PDF Access #direct-pdf-access
While we only store PDFs in the
tmp directory for short periods, this behaviour may change in future if caching is added. With that in mind, we use a
.htaccess file to prevent direct access to those PDFs saved to disk. Users running Apache or LiteSpeed web servers are automatically secured, however Nginx, IIS and other web servers will need manual intervention.
Private PDF Directory #private-pdf-directory
The simplest approach to protect the PDFs saved to disk – without having to worry about specific web server configuration – is to move the
tmp folder outside the public directory structure. This can be done using the
gfpdf_tmp_location filter. Follow the instructions in the link and place the example snippet in your theme’s
functions.php file or create a Must Use plugin.
To test the filter works correctly submit a new Gravity Form entry and look for the private folder you’ve set. Inside should be a
.htaccess file. Once the new location has been verified delete the old
tmp directory from your server.
If you don’t want to move the
tmp directory to a non-public folder (or cannot), and you are not running Apache or Litespeed servers (you are automatically protected), you should consult your web server documentation for details on preventing direct access to files inside a public directory.
Prevent Owner Access #prevent-owner-access
If your PDF is never meant to be viewed by the end user you can enable the Restrict Owner security setting. This will ensure only logged in users with roles assigned the capabilities set in the global User Restriction setting have access to the document.
Enable Public Access #enable-public-access
If you want to enable public access to the PDFs generated from your Gravity Form you can do so with the Enable Public Access option. Use this option sparingly as it will allow anyone worldwide to access PDFs generated from your form – search engines may even index the documents (but are discouraged to do so). In the majority of cases the standard security protocols are sufficient.
Sensitive User Information #sensitive-user-information
If you are collecting sensitive data from your users there are a number of best-practice protocols you should consider implementing to protect that information. These include:
- Install an SSL certificate and correctly enable HTTPS on your website. For better trust between you and your users you might opt for an EV Certificate. A new service, Let’s Encrypt, offer free SSL certificates for those with a dedicated server. Test your HTTPS implementation by running an SSL Server test – aim for an “A+”.
Use dedicated web hosting (or similar). Ensure the hosting service you choose meets your country’s regulations in regard to the data being collected – an example being Amazon’s Cloud Compliance.
If you collect and store credit card details on your server you should (read: must) be PCI-compliant. Even if you aren’t storing payment details, the user information you are storing may be sensitive enough that you could follow PCI best-practice.
Encrypt your dedicated server’s file system as well as the database.
Ensure WordPress and its plugins are regularly updated.
Do not send sensitive user information via email. This includes in the email body or as an attachment. Instead use the
[gravitypdf]shortcode to send a link to the PDF, or place a download link on the confirmation page.
Enable PDF password protection and use a strong password (over 10 characters using a mix of letters, numbers and symbols). PDFs use 128-bit encryption.
Implement strong password policies, enhance your password encryption, and enable two-step authentication for all accounts.
The list above is just some of the ways you can keep your website and user data secure. Remember, security is not “set and forget”. It is an on-going process and you should remain ever vigilant.