<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[12763] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php: Plugin Directory: Bin: Add a script to bulk email plugin authors of vulnerabilities from a CSV.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { white-space: pre-line; overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/12763">12763</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/12763","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2023-07-27 07:11:51 +0000 (Thu, 27 Jul 2023)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Plugin Directory: Bin: Add a script to bulk email plugin authors of vulnerabilities from a CSV.</pre>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorybinemailbulksecurityvulnerabilitiesphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectorybinemailbulksecurityvulnerabilitiesphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php 2023-07-27 07:11:51 UTC (rev 12763)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,329 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+namespace WordPressdotorg\Plugin_Directory\Bin\BulkSecurityEmails;
+use WordPressdotorg\Plugin_Directory\Plugin_Directory;
+use WordPressdotorg\Plugin_Directory\Tools;
+
+use WordPressdotorg\MU_Plugins\Utilities\HelpScout; // NOTE: NOT the same as the HelpScout class in this plugin.
+
+/**
+ * This script will process a given CSV and close/email plugin authors.
+ *
+ * NOTE: The emails created in HelpScout will not be sent. We must also send it (Which this script does).
+ * As a result, replies to the email will NOT thread properly.
+ *
+ * The CSV should contain multiple fields.
+ * - At least one must be the 'slug', this is the plugin it will be looking for.
+ * - Additional fields MUST be specified, these will be included in the email to the author as the details of the vulnerability.
+ *
+ * Plugins with 10k or over installs, will be given a 30day grace period. Followupthen is used to remind us.
+ * Plugins with less than 10k installs are closed immediately and informed.
+ *
+ * The --only-warn parameter can be passed to only email plugin authors, and not close the plugin.
+ * This may be useful if the plugin has been updated recently.
+ * NOTE: The template will reference 'standing in the community and the size of your user base' which may be incorrect.
+ */
+
+// This script should only be called in a CLI environment.
+if ( 'cli' != php_sapi_name() ) {
+ die();
+}
+
+// Comment out once you're sure you know what you're doing :)
+die( 'Please check the source, and validate this will work as you anticipate.' );
+
+$opts = getopt( '', array( 'url:', 'abspath:', 'csv:', 'only-warn', 'doit' ) );
+
+if ( empty( $opts['url'] ) ) {
+ $opts['url'] = 'https://wordpress.org/plugins/';
+}
+if ( empty( $opts['abspath'] ) && false !== strpos( __DIR__, 'wp-content' ) ) {
+ $opts['abspath'] = substr( __DIR__, 0, strpos( __DIR__, 'wp-content' ) );
+}
+
+// Dry-run or live mode?
+define( __NAMESPACE__ . '\OPERATION_MODE', isset( $opts['doit'] ) ? 'live' : 'dry-run' );
+
+// Bootstrap WordPress
+$_SERVER['HTTP_HOST'] = parse_url( $opts['url'], PHP_URL_HOST );
+$_SERVER['REQUEST_URI'] = parse_url( $opts['url'], PHP_URL_PATH );
+
+require rtrim( $opts['abspath'], '/' ) . '/wp-load.php';
+
+if ( ! class_exists( '\WordPressdotorg\Plugin_Directory\Plugin_Directory' ) ) {
+ fwrite( STDERR, "Error! This site doesn't have the Plugin Directory plugin enabled.\n" );
+ if ( defined( 'WPORG_PLUGIN_DIRECTORY_BLOGID' ) ) {
+ fwrite( STDERR, "Run the following command instead:\n" );
+ fwrite( STDERR, "\tphp " . implode( ' ', $argv ) . ' --url ' . get_site_url( WPORG_PLUGIN_DIRECTORY_BLOGID, '/' ) . "\n" );
+ }
+ die();
+}
+
+if ( empty( $opts['csv'] ) ) {
+ die( "Need a --csv param." );
+}
+
+if ( 'live' == OPERATION_MODE ) {
+ echo "Running in live mode. Changes will be made.\nProceeding in 10s...\n";
+ sleep( 10 );
+
+} else {
+ echo "Running in dry-run mode. No changes will be made. Pass --doit parameter to make changes.\n";
+}
+
+// Load the HelpScout API helper methods.
+require_once API_WPORGPATH . '/dotorg/helpscout/common.php';
+
+// Set a user to run as.
+wp_set_current_user( get_user_by( 'slug', 'wordpressdotorg' )->ID );
+
+const ATTRIBUTE_TO_USER = 544543; // dd32 - This is who should show as having sent it. Fetch it from your HS profile edit url.
+const ASSIGN_TO_USER = 433937; // plugin security team - this is who should be assigned for responses
+const WARN_THRESHOLD = 10000; // active installs to go from instant close => warn w/ 30days.
+
+/**
+ * Fetch the email template from HelpScout.
+ */
+function get_email_template( $name ) {
+ static $ids;
+ static $cache = [];
+
+ $api = HelpScout::instance();
+ $ids ??= wp_list_pluck( $api->get( '/v2/mailboxes/' . $api->get_mailbox_id( 'plugins' ) . '/saved-replies' ), 'id', 'name' );
+ $cache[ $name ] ??= $api->get( '/v2/mailboxes/' . $api->get_mailbox_id( 'plugins' ) . '/saved-replies/' . $ids[ $name ] );
+
+ return $cache[ $name ]->text ?? false;
+}
+
+function fetch_all_from_csv() {
+ global $opts;
+
+ $csv = fopen( $opts['csv'], 'r' );
+ $headers = fgetcsv( $csv );
+
+ // Expect a slug field.
+ $slug_pos = array_search( 'slug', array_map( 'strtolower', $headers ) );
+
+ if ( false === $slug_pos ) {
+ die( 'Unable to find a "Slug" field in the CSV.' );
+ }
+
+ $data = [];
+ while ( ! feof( $csv ) ) {
+ $raw = fgetcsv( $csv );
+
+ $row = array_combine( $headers, $raw );
+
+ $slug = $raw[ $slug_pos ];
+
+ $data[ $slug ] ??= [];
+ $data[ $slug ][] = $row;
+ }
+
+ return $data;
+}
+
+function format_vulns_for_email( $vulns, $plugin ) {
+ $message = '';
+ foreach ( $vulns as $vuln ) {
+ $message .= "Plugin: " . get_permalink( $plugin ) . "\n";
+ foreach ( $vuln as $field => $value ) {
+ if ( 'slug' === strtolower( $field ) || 'plugin' === strtolower( $field ) ) {
+ continue;
+ }
+
+ $message .= "$field: $value\n";
+ }
+ $message .= "\n\n"; // There might be multiple issues per email.
+ }
+
+ return esc_html( trim( $message ) );
+}
+
+/**
+ * Send an email, both by wp_mail() and log it into HelpScout.
+ *
+ * HelpScout allows creation of emails through the API, but does not actually allow you to send an email.
+ * Therefor, we send the email, and create it within HS.
+ * Unfortunately, replies do not thread to the created email.. but at least we have a log..
+ */
+function send_email( $args ) {
+ global $opts;
+
+ $filter = function() { return 'text/html'; };
+ add_filter( 'wp_mail_content_type', $filter );
+
+ wp_mail(
+ $args['to'] ?? '',
+ $args['subject'] ?? '',
+ str_replace( "<br />", "<br />\n", $args['body'] ?? '' ),
+ array_filter( [
+ 'From: WordPress.org Plugin Directory <plugins@wordpress.org>',
+ 'Return-Path: <plugins@wordpress.org>',
+ ( $args['cc'] ? 'CC: ' . implode( ', ', $args['cc'] ) : '' ),
+ ( $args['bcc'] ? 'BCC: ' . implode( ', ', (array) $args['bcc'] ) : '' ),
+ ] )
+ );
+ remove_filter( 'wp_mail_content_type', $filter );
+
+ $api = HelpScout::instance();
+ $payload = [
+ 'type' => 'email',
+ 'assignTo' => ASSIGN_TO_USER,
+ 'mailboxId' => $api->get_mailbox_id( 'plugins' ),
+ 'status' => 'closed',
+ 'imported' => true,
+ 'customer' => array_filter( [
+ 'email' => $args['to'] ?? '',
+ 'firstName' => explode( ' ', $args['name'] ?? '', 2 )[0] ?? '',
+ 'lastName' => explode( ' ', $args['name'] ?? '', 2 )[1] ?? '',
+ ] ),
+ 'subject' => $args['subject'] ?? '',
+ 'threads' => [
+ [
+ 'type' => 'note',
+ 'text' => 'This was automated by <code>bin/email-bulk-security-vulnerabilities.php</code> processing a CSV file: <code>' . ( $opts['csv'] ?? '' ) . '</code>',
+ 'user' => ATTRIBUTE_TO_USER
+ ],
+ [
+ 'type' => 'reply',
+ 'cc' => (array) ( $args['cc'] ?? [] ),
+ 'bcc' => (array) ( $args['bcc'] ?? [] ),
+ 'text' => $args['body'] ?? '',
+ 'customer' => [
+ 'email' => 'plugins@wordpress.org',
+ ],
+ 'user' => ATTRIBUTE_TO_USER
+ ]
+ ]
+ ];
+
+ return $api->post( '/v2/conversations', $payload );
+}
+
+$stats = [
+ 'processed' => 0,
+ 'closed' => 0,
+ 'warned' => 0,
+ 'error' => 0,
+];
+
+$all_csv_vulns = fetch_all_from_csv();
+
+/*
+$all_csv_vulns = [
+ 'plugin-slug' => [
+ [
+ 'Slug' => 'plugin-slug',
+ 'Link' => 'https://example.org',
+ 'Version' => 'Verified in 1.0.0',
+ 'Description' => 'Plugin is vulnerable to a XSS attack.',
+ ]
+ ]
+];
+*/
+
+$only_warn = isset( $opts['only-warn'] );
+
+foreach ( $all_csv_vulns as $plugin_slug => $vulns ) {
+ $plugin = Plugin_Directory::get_plugin_post( $plugin_slug );
+ if ( ! $plugin ) {
+ $stats['error']++;
+ echo "ERROR: Plugin not found: $plugin_slug\n\n";
+ continue;
+ }
+
+ if ( 'publish' != $plugin->post_status ) {
+ $stats['error']++;
+ echo "ERROR: Plugin not published: $plugin_slug\n\n";
+ continue;
+ }
+
+ $stats['processed']++;
+
+ $author = get_user_by( 'id', $plugin->post_author );
+ $to = $author->user_email;
+ $name = $author->display_name ?: $author->user_login;
+
+ $committers = Tools::get_plugin_committers( $plugin );
+ $committers = array_map( function ( $user_login ) {
+ return get_user_by( 'login', $user_login );
+ }, $committers );
+
+ $cc = wp_list_pluck( $committers, 'user_email' );
+ $cc = array_values( array_diff( $cc, array( $author->user_email ) ) );
+ $cc_list = implode( ', ', $cc );
+
+ $active_installs = (int) $plugin->active_installs;
+ $vuln_desc = format_vulns_for_email( $vulns, $plugin );
+
+ if ( $active_installs >= WARN_THRESHOLD || $only_warn ) {
+ // WARN, with a 30day followup.
+ $email_template = get_email_template( 'Warning: Security Issue (NOT CLOSED)' );
+ $subject = '[WordPress Plugin Directory] Security Notice: ' . $plugin->post_title;
+ $bcc = '30days@followupthen.com';
+
+ $body = $email_template;
+ $body = str_replace( 'PLUGIN_LINK', get_permalink( $plugin ), $body );
+ $body = str_replace( 'LINK<br /><br />DETAILS', '<pre>' . $vuln_desc . '</pre>', $body );
+
+ echo "Subject: $subject\n\n";
+ echo "To: $to\n";
+ echo "CC: $cc_list\n";
+ echo str_replace( "<br />", "\n", $body );
+
+ if ( 'live' != OPERATION_MODE ) {
+ continue;
+ }
+
+ send_email( compact( 'subject', 'to', 'name', 'cc', 'bcc', 'body' ) );
+
+ $stats['warned']++;
+
+ // TODO: Add a 30day warning in plugin notes?
+
+ } else {
+ // Close
+
+ $email_template = get_email_template( 'Closed: Security Exploit' );
+ $subject = '[WordPress Plugin Directory] Closure Notice - Security: ' . $plugin->post_title;
+ $bcc = [];
+
+ $body = $email_template;
+ $body = str_replace( 'PLUGIN_LINK', get_permalink( $plugin ), $body );
+ $body = str_replace( 'REPORT<br /><br />OPTIONAL_ADDITIONAL', '<pre>' . $vuln_desc . '</pre>', $body );
+
+ echo "Subject: $subject\n\n";
+ echo "To: $to\n";
+ echo "CC: $cc_list\n";
+ echo str_replace( "<br />", "\n", $body );
+
+ if ( 'live' != OPERATION_MODE ) {
+ continue;
+ }
+
+ send_email( compact( 'subject', 'to', 'cc', 'bcc', 'body' ) );
+
+ // Record why it's closed
+ update_post_meta( $plugin->ID, '_close_reason', 'security-issue' );
+ update_post_meta( $plugin->ID, 'plugin_closed_date', current_time( 'mysql' ) );
+
+ // Change status.
+ wp_update_post( [
+ 'ID' => $plugin->ID,
+ 'post_status' => 'closed',
+ ] );
+
+ Tools::audit_log(
+ 'Plugin closed. Reason: security-issue. <em>Automated by <code>bin/email-bulk-security-vulnerabilities.php</code></em><br>' . $vuln_desc,
+ $plugin
+ );
+
+ $stats['closed']++;
+ }
+
+ echo "\n\n\n";
+}
+
+echo "All Done! Stats: ";
+
+var_dump( $stats );
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/bin/email-bulk-security-vulnerabilities.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>