v6.0.0

Author: John Wineman

APIKey

@@ -0,0 +1,29 @@
+#!/usr/local/cpanel/3rdparty/bin/perl
+
+use strict;
+use Cpanel::AdminBin::Serializer ();
+use Cpanel::Logger               ();
+use Cpanel::PwCache              ();
+use Cpanel::LoadFile             ();
+
+my $HOST_API_KEY_FILE = "/root/.cpanel/datastore/cf_api";
+
+my $stdin = <STDIN>;
+chomp $stdin;
+my ( $uid, $function, $data ) = split( / /, $stdin, 3 );
+
+my $logger = Cpanel::Logger->new();
+
+if ( $function eq 'get_host_api_key' ) {
+    my $host_api_key = Cpanel::LoadFile::loadfile($HOST_API_KEY_FILE) or do {
+        $logger->info("Failed to load Host API key: $!");
+    };
+    print $host_api_key;
+    exit(0);
+}
+else {
+    print "Invalid function specified to APIKey adminbin";
+    exit(1);
+}
+
+1; #Ah, perl

CHANGELOG.md

@@ -2,15 +2,28 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [5.3.11](#5.3.11) - 2016-01-14
-### Fixed
-- Cpanel 11.54 RC broke JS in some .tmpl files, those files now use CloudFlare.$ instead of $ for Jquery [#75](https://github.com/cloudflare/CloudFlare-CPanel/pull/75)
-- Fixed an issue where a malicious symlink could allow changing permissions on arbitrary files. [#76](https://github.com/cloudflare/CloudFlare-CPanel/pull/76)
+## [6.0.0](#6.0.0) - 2016-03-29
+### Added
+- Added the ability to configure the IPV6 functionality on the Performance Page
+- Added the ability to configure the "Always Online" functionality on the Performance Page
+- Added the ability to provision domain names with CloudFlare's "full zone" setup.
+- Added a button to quickly toggle "I'm Under Attack" mode.
+- Added the ability to view requests, bandwidth, unique visitors, and threats blocked on the Analytics page.
+- Added the ability to configure the security level setting of your website on the Security page.
+- Added the ability to configure the challenge passage setting of your website on the Security page.
+- Added the ability to toggle the browser integrity check setting of your website on the Security page.
+- Added the ability to configure the cache level setting of your website on the Performance page.
+- Added the ability to configure the auto minify setting of your website on the Performance page.
+- Added the ability to toggle the development mode setting of your website on the Performance page.
+- Added the ability to configure the browser cache time to live setting on the Perfromance page.
+- Added the ability to purge your website's cache on the Performance page.
 
-## [5.3.10](#5.3.10) - 2016-01-06
-### Changed
-- Updated error messaging when plugin detects that a zone is already active on CloudFlare [#71](https://github.com/cloudflare/CloudFlare-CPanel/pull/71)
-- Plugin now supports v4 Client API. Security page now uses v4 zones/[identifier]/settings/security_level to set the the security level [#70](https://github.com/cloudflare/CloudFlare-CPanel/pull/70)
+### Removed
+- Removed the ability to toggle the always online setting of your website on the Performance page.
+- Removed the ability to toggle the IPv6 setting of your website on the Performance page.
+- Removed the header navigation link to http://cloudflarestatus.com/.
+- Removed support for the X3 theme because CPanel is deprecating it in [v11.60](https://blog.cpanel.com/its-time-to-say-goodbye-to-x3/).
 
-### Fixed
-- Fixed a bug where activation failed when www is an A record. [#73](https://github.com/cloudflare/CloudFlare-CPanel/pull/73)
+### Updated
+- The plugin now runs on a React/Redux front end and PHP (with one Perl module) on the backend.
+- The structure of the YAML file has been changed and the data store code will automatically convert old YAML files to the new format.

CloudFlare.pm

@@ -0,0 +1,66 @@
+package Cpanel::API::CloudFlare;
+
+use strict;
+
+
+#Version of perl module NOT plugin.
+our $VERSION = '1.0';
+
+# Your comments about this custom module.
+
+# Cpanel Dependencies
+use Cpanel                   ();
+use Cpanel::API              ();
+use Cpanel::Locale           ();
+use Cpanel::Logger           ();
+use Data::Dumper;
+
+# Other dependencies go here.
+# Defaults go here.
+# Constants go here.
+
+# Globals
+my $logger = Cpanel::Logger->new();;
+
+# Caches go here.
+
+# Functions go here.
+
+#-------------------------------------------------------------------------------------------------
+# Name:
+#   get_host_api_key - Gets the host API key as root
+# Desc:
+#   Gets the host API key as root
+# Arguments:
+#   n/a
+# Returns:
+#   $result1 - string - The host API key
+#-------------------------------------------------------------------------------------------------
+sub get_host_api_key {
+
+    my ( $args, $result ) = @_;
+
+    # https://documentation.cpanel.net/display/SDK/Guide+to+API+Privilege+Escalation+-+Application+Files
+    # Makes a call to /usr/local/cpanel/bin/admin/CloudFlare/APIKey which runs as root to obtain
+    # the host API key stored at /root/.cpanel/datastore/cf_api.
+
+    my $admin_bin_call = Cpanel::Wrap::send_cpwrapd_request(
+           'namespace' => 'CloudFlare',
+           'module'    => 'APIKey',
+           'function'  => 'get_host_api_key',
+    );
+
+    my $host_api_key = $admin_bin_call->{'data'};
+    $host_api_key =~ s/\n//; #string replace new line with nothing
+
+    if (defined $host_api_key) {
+        $result->data($host_api_key);
+        return 1;
+    }
+    else {
+        $logger->warn("Failed to load Host API key.");
+        return 0;
+    }
+}
+
+1; #Ah, perl

Gruntfile.js

@@ -0,0 +1,11 @@
+Copyright (c) 2016, CloudFlare. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

LICENSE.md

@@ -0,0 +1,24 @@
+## CloudFlare cPanel Quick Installation Instructions
+
+Using an SSH client such as Terminal or Putty:
+
+Step 1. Access cPanel for the server using root user by:
+
+`ssh root@SERVER IP ADDRESS or SERVER NAME`
+
+Step 2. Download necessary files and run installation
+
+`bash <(curl -s https://raw.githubusercontent.com/cloudflare/CloudFlare-CPanel/master/cloudflare.install.sh) -k [YOUR HOST KEY] -n '[YOUR_COMPANY_NAME]' `
+
+NOTES:
+- Be sure to replace [HOST_API_KEY] and [YOUR_COMPANY_NAME] with the appropriate values
+
+### Uninstalling the cPanel Plugin
+
+An uninstall script has been provided to unregister the plugin with cPanel and remove all CloudFlare specific files from the server to deactivate the plugin.
+
+NOTE: This will not remove zones or users from CloudFlare that have been registered through the plugin.
+
+The following set of commands will download the necessary files, execute the uninstall script and ultimately remove the uninstall script as well:
+
+`bash <(curl -s https://raw.githubusercontent.com/cloudflare/CloudFlare-CPanel/master/cloudflare.uninstall.sh) && rm -f cloudflare.uninstall.sh