Bootstrapped api key extractor package

refs https://github.com/TryGhost/Toolbox/issues/292

- The package is meant to be one stop shop for extraction of any API keys from requests known to Ghost
- To start with it should detect and return keys for Content and Admin APIs for the purposes of api version mismatch handling

ghost/extract-api-key/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/node'
+    ]
+};

ghost/extract-api-key/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013-2022 Ghost Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ghost/extract-api-key/README.md

@@ -0,0 +1,41 @@
+# Extract Api Key
+
+Extracts API key value from requests in formats known to Ghost
+
+## Install
+
+`npm install @tryghost/extract-api-key --save`
+
+or
+
+`yarn add @tryghost/extract-api-key`
+
+
+## Usage
+
+
+## Develop
+
+This is a mono repository, managed with [lerna](https://lernajs.io/).
+
+Follow the instructions for the top-level repo.
+1. `git clone` this repo & `cd` into it as usual
+2. Run `yarn` to install top-level dependencies.
+
+
+## Run
+
+- `yarn dev`
+
+
+## Test
+
+- `yarn lint` run just eslint
+- `yarn test` run lint and tests
+
+
+
+
+# Copyright & License 
+
+Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).

ghost/extract-api-key/index.js

@@ -0,0 +1 @@
+module.exports = require('./lib/extract-api-key');

ghost/extract-api-key/lib/extract-api-key.js

@@ -0,0 +1,24 @@
+/**
+ * @typedef {object} ApiKey
+ * @prop {string} key
+ * @prop {string} type
+ */
+
+/**
+ *
+ * @param {import('express').Request} req
+ * @returns {ApiKey}
+ */
+const extractAPIKey = (req) => {
+    let key = null;
+    let type = null;
+
+    if (req.query && req.query.key) {
+        type = 'content';
+        key = req.query.key;
+    }
+
+    return {key, type};
+};
+
+module.exports = extractAPIKey;

ghost/extract-api-key/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@tryghost/extract-api-key",
+  "version": "0.0.0",
+  "repository": "https://github.com/TryGhost/Utils/tree/main/packages/extract-api-key",
+  "author": "Ghost Foundation",
+  "license": "MIT",
+  "main": "index.js",
+  "scripts": {
+    "dev": "echo \"Implement me!\"",
+    "test": "NODE_ENV=testing c8 --all --check-coverage --reporter text --reporter cobertura mocha './test/**/*.test.js'",
+    "lint:code": "eslint *.js lib/ --ext .js --cache",
+    "lint": "yarn lint:code && yarn lint:test",
+    "lint:test": "eslint -c test/.eslintrc.js test/ --ext .js --cache",
+    "posttest": "yarn lint"
+  },
+  "files": [
+    "index.js",
+    "lib"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {},
+  "dependencies": {}
+}

ghost/extract-api-key/test/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+    plugins: ['ghost'],
+    extends: [
+        'plugin:ghost/test'
+    ]
+};

ghost/extract-api-key/test/extract-api-key.test.js

@@ -0,0 +1,15 @@
+const assert = require('assert');
+const extractApiKey = require('../index');
+
+describe('Extract API Key', function () {
+    it('Extracts Content API key from the request', function () {
+        const {key, type} = extractApiKey({
+            query: {
+                key: '123thekey'
+            }
+        });
+
+        assert.equal(key, '123thekey');
+        assert.equal(type, 'content');
+    });
+});