Changeset 43095

Timestamp:

05/02/2018 02:32:57 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Privacy: Add cron to delete expired export files to protect privacy.

The primary means of protecting the files is the CSPRN appended to the filename, but there is no reason to keep the files after the data subject has downloaded them, so deleting them provides an additional layer of protection. Previously this was done from wp_privacy_generate_personal_data_export_file(), but that does not guarantee that it will be run regularly, and on smaller sites that could result in export files being exposed for much longer than necessary.

wp_privacy_delete_old_export_files() was moved to a front end file, so that it can be called from cron.php.

This introduces the wp_privacy_export_expiration filter, which allows plugins to customize how long the exports are kept before being deleted.

index.html was added to the $exclusions parameter of list_files() to make sure that it isn't deleted. If it were, then poorly-configured servers would allow the directory to be traversed, exposing all of the exported files.

Props iandunn, desrosj.
Merges [43046] to the 4.9 branch.
See #43546.

Location:

branches/4.9

Files:

• . (modified) (1 prop)
• src/wp-admin/includes/file.php (modified) (5 diffs)
• src/wp-includes/default-filters.php (modified) (1 diff)
• src/wp-includes/functions.php (modified) (1 diff)

branches/4.9/src/wp-admin/includes/file.php

@@ -1863 +1863 @@
  */
 function wp_privacy_generate_personal_data_export_file( $request_id ) {
-    // Maybe make this a cron job instead.
-    wp_privacy_delete_old_export_files();
-
     if ( ! class_exists( 'ZipArchive' ) ) {
         wp_send_json_error( __( 'Unable to generate export file. ZipArchive not available.' ) );
@@ -2026 +2023 @@
     }
 
-/* translators: Do not translate LINK, EMAIL, SITENAME, SITEURL: those are placeholders. */
+    /** This filter is documented in wp-admin/includes/file.php */
+    $expiration      = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
+    $expiration_date = date_i18n( get_option( 'date_format' ), time() + $expiration );
+
+/* translators: Do not translate EXPIRATION, LINK, EMAIL, SITENAME, SITEURL: those are placeholders. */
 $email_text = __(
 'Howdy,
 
 Your request for an export of personal data has been completed. You may
-download your personal data by clicking on the link below. This link is
-good for the next 3 days.
+download your personal data by clicking on the link below. For privacy
+and security, we will automatically delete the file on ###EXPIRATION###,
+so please download it before then.
 
 ###LINK###
@@ -2047 +2049 @@
      *
      * The following strings have a special meaning and will get replaced dynamically:
+     * ###EXPIRATION###         The date when the URL will be automatically deleted.
      * ###LINK###               URL of the personal data export file for the user.
      * ###EMAIL###              The email we are sending to.
@@ -2064 +2067 @@
     $site_url = network_home_url();
 
+    $content = str_replace( '###EXPIRATION###', $expiration_date, $content );
     $content = str_replace( '###LINK###', esc_url_raw( $export_file_url ), $content );
     $content = str_replace( '###EMAIL###', $email_address, $content );
@@ -2208 +2212 @@
     return $response;
 }
-
-/**
- * Cleans up export files older than three days old.
- *
- * @since 4.9.6
- */
-function wp_privacy_delete_old_export_files() {
-    $upload_dir   = wp_upload_dir();
-    $exports_dir  = trailingslashit( $upload_dir['basedir'] . '/exports' );
-    $export_files = list_files( $exports_dir );
-
-    foreach( (array) $export_files as $export_file ) {
-        $file_age_in_seconds = time() - filemtime( $export_file );
-
-        if ( 3 * DAY_IN_SECONDS < $file_age_in_seconds ) {
-            @unlink( $export_file );
-        }
-    }
-}

branches/4.9/src/wp-includes/default-filters.php

@@ -326 +326 @@
 add_filter( 'wp_privacy_personal_data_exporters', 'wp_register_comment_personal_data_exporter' );
 add_filter( 'wp_privacy_personal_data_erasers', 'wp_register_comment_personal_data_eraser' );
+add_action( 'init', 'wp_schedule_delete_old_privacy_export_files' );
+add_action( 'wp_privacy_delete_old_export_files', 'wp_privacy_delete_old_export_files' );
 
 // Cron tasks

branches/4.9/src/wp-includes/functions.php

@@ -5935 +5935 @@
     return apply_filters( 'wp_privacy_anonymize_data', $anonymous, $type, $data );
 }
+
+/**
+ * Schedule a `WP_Cron` job to delete expired export files.
+ *
+ * @since 4.9.6
+ */
+function wp_schedule_delete_old_privacy_export_files() {
+    if ( ! wp_next_scheduled( 'wp_privacy_delete_old_export_files' ) ) {
+        wp_schedule_event( time(), 'hourly', 'wp_privacy_delete_old_export_files' );
+    }
+}
+
+/**
+ * Cleans up export files older than three days old.
+ *
+ * The export files are stored in `wp-content/uploads`, and are therefore publicly
+ * accessible. A CSPRN is appended to the filename to mitigate the risk of an
+ * unauthorized person downloading the file, but it is still possible. Deleting
+ * the file after the data subject has had a chance to delete it adds an additional
+ * layer of protection.
+ *
+ * @since 4.9.6
+ */
+function wp_privacy_delete_old_export_files() {
+    $upload_dir   = wp_upload_dir();
+    $exports_dir  = trailingslashit( $upload_dir['basedir'] . '/exports' );
+    $export_files = list_files( $exports_dir, 100, array( 'index.html' ) );
+
+    /**
+     * Filters the lifetime, in seconds, of a personal data export file.
+     *
+     * By default, the lifetime is 3 days. Once the file reaches that age, it will automatically
+     * be deleted by a cron job.
+     *
+     * @since 4.9.6
+     *
+     * @param int $expiration The expiration age of the export, in seconds.
+     */
+    $expiration = apply_filters( 'wp_privacy_export_expiration', 3 * DAY_IN_SECONDS );
+
+    foreach ( (array) $export_files as $export_file ) {
+        $file_age_in_seconds = time() - filemtime( $export_file );
+
+        if ( $expiration < $file_age_in_seconds ) {
+            unlink( $export_file );
+        }
+    }
+}