tag below the field - */ - public function getHTMLFragments($gridField) { - $button = new GridField_FormAction( - $gridField, - 'addapikey', - _t('GridFieldAddApiKeyButton.CREATE_API_KEY', 'Create API Key'), - 'addapikey', - null - ); - $button->setAttribute('data-icon', 'add'); - - return array( - $this->targetFragment => $button->Field(), - ); - } - - public function getActions($gridField) { - return array('addApiKey'); - } - - public function handleAction(GridField $gridField, $actionName, $arguments, $data) { - if($actionName == 'addapikey') { - MemberApiKey::createKey($gridField->getForm()->getRecord()->ID); - } - } -} diff --git a/code/MemberApiKey.php b/code/MemberApiKey.php deleted file mode 100644 index 54ad520..0000000 --- a/code/MemberApiKey.php +++ /dev/null @@ -1,97 +0,0 @@ - 'Varchar', - 'LastUsed' => 'Datetime', - 'TimesUsed' => 'Int', - ]; - - private static $indexes = [ - 'ApiKeyIdx' => ['type' => 'unique', 'value' => '"ApiKey"' ], - ]; - - private static $has_one = [ - 'Member' => 'Member', - ]; - - private static $summary_fields = [ - 'ApiKey', - 'LastUsed', - 'TimesUsed', - ]; - - /** - * Defines the length of randomly-generated keys - */ - private static $key_length = 48; - - /** - * MemberApiKey factory. Writes to the database. - * @param int $memberID The member to create a key for - * @return MemberApiKey - */ - public static function createKey($memberID) { - // Basic argument validation - if(!$memberID || !is_numeric($memberID)) { - throw new InvalidArgumentException('Please pass a numeric $memberID'); - } - - // Find a unique key - $key = self::randKey(); - while(MemberApiKey::get()->filter(['ApiKey' => $key])->count() > 0) { - $key = self::randKey(); - } - - // Construct record - $obj = new MemberApiKey; - $obj->MemberID = $memberID; - $obj->ApiKey = $key; - $obj->write(); - - return $obj; - } - - /** - * Find the relevant MemberApiKey object for the given key - */ - public static function findByKey($key) { - $matches = MemberApiKey::get()->filter(['ApiKey' => $key]); - switch($matches->count()) { - case 1: - return $matches->first(); - - case 0: - return null; - - default: - throw new LogicException("Multiple MemberApiKey records for '$key' - database corrupt!"); - } - } - - /** - * Mark the given key as used. - * Keeps usage stats up-to-date - */ - public function markUsed() { - $this->LastUsed = date('Y-m-d H:i:s'); - $this->TimesUsed++; - $this->write(); - } - - /** - * Helper function to generate a random key - */ - protected static function randKey() { - $key = ''; - $src = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'; - $keyLength = Config::inst()->get('MemberApiKey', 'key_length'); - - for($i = 0; $i < $keyLength; $i++) { - $key .= $src[rand(0, strlen($src)-1)]; - } - - return $key; - } -} \ No newline at end of file diff --git a/composer.json b/composer.json index 5349c03..70e9587 100644 --- a/composer.json +++ b/composer.json @@ -3,7 +3,7 @@ "description": "API Key management for SilverStripe", "type": "silverstripe-module", "require": { - "silverstripe/framework": "^3.1" + "silverstripe/framework": "^4.0@dev" }, "license": "BSD-3-Clause", "authors": [ @@ -11,5 +11,17 @@ "name": "Sam Minnee", "email": "sam@silverstripe.com" } - ] + ], + "extra": { + "branch-alias": { + "dev-master": "1.0.x-dev" + } + }, + "autoload": { + "psr-4": { + "Sminnee\\ApiKey\\": "src/" + } + }, + "minimum-stability": "dev", + "prefer-stable": true } diff --git a/src/ApiKeyMemberExtension.php b/src/ApiKeyMemberExtension.php new file mode 100644 index 0000000..95cd8d9 --- /dev/null +++ b/src/ApiKeyMemberExtension.php @@ -0,0 +1,42 @@ + MemberApiKey::class, + ]; + + public function updateCMSFields(FieldList $fields) + { + $grid = $fields->dataFieldByName('ApiKeys'); + if (!$grid) { + return; + } + + $gridConfig = $grid->getConfig(); + + // Simplify view + $gridConfig->removeComponentsByType(GridFieldAddExistingAutocompleter::class); + $gridConfig->removeComponentsByType(GridFieldDetailForm::class); + $gridConfig->removeComponentsByType(GridFieldEditButton::class); + + // Better add key button + $gridConfig->removeComponentsByType(GridFieldAddNewButton::class); + $gridConfig->addComponent(new GridFieldAddApiKeyButton('buttons-before-left')); + + // Replace unlink with a real delete + $gridConfig->removeComponentsByType(GridFieldDeleteAction::class); + $gridConfig->addComponent(new GridFieldDeleteAction()); + } +} diff --git a/src/ApiKeyRequestFilter.php b/src/ApiKeyRequestFilter.php new file mode 100644 index 0000000..2f6ab24 --- /dev/null +++ b/src/ApiKeyRequestFilter.php @@ -0,0 +1,57 @@ +get(self::class, 'header_name'); + + if ($key = $request->getHeader($headerName)) { + try { + $matchingKey = MemberApiKey::findByKey($key); + } catch (LogicException $e) { + } + + if ($matchingKey) { + // Log-in can't have session injected, we need to to push $session into the global state + $controller = new Controller; + $controller->setSession($session); + $controller->pushCurrent(); + + $matchingKey->Member()->logIn(); + + // Undo our global state manipulation + $controller->popCurrent(); + + $matchingKey->markUsed(); + } else { + throw new HTTPResponse_Exception("Bad X-API-Key", 400); + } + } + + return true; + } + + public function postRequest(HTTPRequest $request, HTTPResponse $response, DataModel $model) + { + return true; + } +} diff --git a/src/GridFieldAddApiKeyButton.php b/src/GridFieldAddApiKeyButton.php new file mode 100644 index 0000000..0d6f46e --- /dev/null +++ b/src/GridFieldAddApiKeyButton.php @@ -0,0 +1,64 @@ +targetFragment = $targetFragment; + } + + /** + * Place the export button in a
tag below the field + */ + public function getHTMLFragments($gridField) + { + $button = new GridField_FormAction( + $gridField, + 'addapikey', + _t('GridFieldAddApiKeyButton.CREATE_API_KEY', 'Create API Key'), + 'addapikey', + null + ); + $button->setAttribute('data-icon', 'add'); + + return array( + $this->targetFragment => $button->Field(), + ); + } + + public function getActions($gridField) + { + return array('addApiKey'); + } + + public function handleAction(GridField $gridField, $actionName, $arguments, $data) + { + if ($actionName == 'addapikey') { + MemberApiKey::createKey($gridField->getForm()->getRecord()->ID); + } + } +} diff --git a/src/MemberApiKey.php b/src/MemberApiKey.php new file mode 100644 index 0000000..a788477 --- /dev/null +++ b/src/MemberApiKey.php @@ -0,0 +1,109 @@ + 'Varchar', + 'LastUsed' => 'DBDatetime', + 'TimesUsed' => 'Int', + ]; + + private static $indexes = [ + 'ApiKeyIdx' => ['type' => 'unique', 'value' => '"ApiKey"' ], + ]; + + private static $has_one = [ + 'Member' => Member::class + ]; + + private static $summary_fields = [ + 'ApiKey', + 'LastUsed', + 'TimesUsed', + ]; + + /** + * Defines the length of randomly-generated keys + */ + private static $key_length = 48; + + /** + * MemberApiKey factory. Writes to the database. + * @param int $memberID The member to create a key for + * @return MemberApiKey + */ + public static function createKey($memberID) + { + // Basic argument validation + if (!$memberID || !is_numeric($memberID)) { + throw new InvalidArgumentException('Please pass a numeric $memberID'); + } + + // Find a unique key + $key = self::randKey(); + while (MemberApiKey::get()->filter(['ApiKey' => $key])->count() > 0) { + $key = self::randKey(); + } + + // Construct record + $obj = new MemberApiKey; + $obj->MemberID = $memberID; + $obj->ApiKey = $key; + $obj->write(); + + return $obj; + } + + /** + * Find the relevant MemberApiKey object for the given key + */ + public static function findByKey($key) + { + $matches = MemberApiKey::get()->filter(['ApiKey' => $key]); + switch ($matches->count()) { + case 1: + return $matches->first(); + + case 0: + return null; + + default: + throw new LogicException("Multiple MemberApiKey records for '$key' - database corrupt!"); + } + } + + /** + * Mark the given key as used. + * Keeps usage stats up-to-date + */ + public function markUsed() + { + $this->LastUsed = date('Y-m-d H:i:s'); + $this->TimesUsed++; + $this->write(); + } + + /** + * Helper function to generate a random key + */ + protected static function randKey() + { + $key = ''; + $src = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ'; + $keyLength = Config::inst()->get(self::class, 'key_length'); + + for ($i = 0; $i < $keyLength; $i++) { + $key .= $src[rand(0, strlen($src)-1)]; + } + + return $key; + } +}