Skip to content

One more API Key Length PR #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
froboy wants to merge 1 commit into
base: master
Choose a base branch
from
Open

One more API Key Length PR #37

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 14 additions & 24 deletions src/ApiEndpoints/CloudFlareAPI.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,11 +47,13 @@ abstract class CloudFlareAPI {
const REQUEST_ALL_PAGES = -1;
const API_ENDPOINT_BASE = 'https://api.cloudflare.com/client/v4/';

// The length of the Api key.
// The length of the Global Api key.
// The Api will throw a non-descriptive http code: 400 exception if the key
// length is greater than 37. If the key is invalid but the expected length
// the Api will return a more informative http code of 403.
const API_KEY_LENGTH = 37;
const GLOBAL_API_KEY_LENGTH = 37;
// The length of the Api key.
const API_KEY_LENGTH = 40;

// The CloudFlare API sets a maximum of 1,200 requests in a 5-minute period.
const API_RATE_LIMIT = 1200;
Expand All @@ -63,10 +65,10 @@ abstract class CloudFlareAPI {
const MAX_TAG_PURGES_PER_REQUEST = 30;

// Time in seconds.
const HTTP_CONNECTION_TIMEOUT = 1.5;
const HTTP_CONNECTION_TIMEOUT = 15;

// Time in seconds.
const HTTP_TIMEOUT = 3;
const HTTP_TIMEOUT = 30;

// MAX Number of results returned by the API in one request.
const MAX_ITEMS_PER_PAGE = 50;
Expand All @@ -93,10 +95,15 @@ public function __construct($apikey, $email, MockHandler $mock_handler = NULL) {
$this->apikey = $apikey;
$this->email = $email;
$headers = [
'X-Auth-Key' => $apikey,
'X-Auth-Email' => $email,
'Content-Type' => 'application/json',
];
if (strlen($apikey) === self::API_KEY_LENGTH) {
$headers['Authorization'] = 'Bearer ' . $apikey;
}
else {
$headers['X-Auth-Key'] = $apikey;
$headers['X-Auth-Email'] = $email;
}

$client_params = [
'base_uri' => self::API_ENDPOINT_BASE,
Expand Down Expand Up @@ -139,24 +146,7 @@ protected function makeRequest($request_type, $api_end_point, $request_params =
if (!isset($request_params['per_page'])) {
$request_params['per_page'] = self::MAX_ITEMS_PER_PAGE;
}
// This check seems superfluous. However, the Api only returns a http 400
// code. This proactive check gives us more information.
$is_api_key_valid = strlen($this->apikey) == CloudFlareAPI::API_KEY_LENGTH;
$is_api_key_alpha_numeric = ctype_alnum($this->apikey);
$is_api_key_lower_case = !(preg_match('/[A-Z]/', $this->apikey));

if (!$is_api_key_valid) {
throw new CloudFlareInvalidCredentialException("Invalid Api Key: Key should be 37 chars long.", 403);
}

if (!$is_api_key_alpha_numeric) {
throw new CloudFlareInvalidCredentialException('Invalid Api Key: Key can only contain alphanumeric characters.', 403);
}

if (!$is_api_key_lower_case) {
throw new CloudFlareInvalidCredentialException('Invalid Api Key: Key can only contain lowercase or numerical characters.', 403);
}


try {
switch ($request_type) {
case self::REQUEST_TYPE_GET:
Expand Down