Initial commit v1.0.0

Author: antwhite

.editorconfig

@@ -0,0 +1,16 @@
+# EditorConfig is awesome: http://EditorConfig.org
+ 
+root = true
+
+[*.js]
+charset = utf-8
+end_of_line = lf
+indent_style = space
+indent_size = 2
+insert_final_newline = false
+ 
+[*.json]
+indent_size = 2
+
+[*.jade]
+indent_size = 2

.eslintignore

@@ -0,0 +1,4 @@
+**/_package/**
+**/node_modules/**
+**/coverage/**
+**/.idea/**

.eslintrc.json

@@ -0,0 +1,25 @@
+{
+  "plugins": [
+    "prettier"
+  ],
+  "rules": {
+    "prettier/prettier": "error",
+    "no-var": "error",
+    "quotes": [
+      "error",
+      "single",
+      {
+        "avoidEscape": true
+      }
+    ],
+    "one-var": [
+      "error",
+      "never"
+    ],
+    "prefer-const": "error"
+  },
+  "parserOptions": {
+    "ecmaVersion": 8,
+    "sourceType": "module"
+  }
+}

.gitignore

@@ -0,0 +1,62 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+
+**/_package/**
+**/coverage/**

.prettierrc.json

@@ -0,0 +1,3 @@
+{
+  "singleQuote": true
+}

.travis.yml

@@ -0,0 +1,12 @@
+language: node_js
+
+matrix:
+  include:
+    - node_js: "6"
+    - node_js: "8"
+
+after_script:
+  - npm run coverage
+
+notifications:
+  email: false

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 OpenComponents community
+
+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.

README.md

@@ -0,0 +1,104 @@
+# oc-plugin-jwt [![Greenkeeper badge](https://badges.greenkeeper.io/opencomponents/oc-plugin-jwt.svg)](https://greenkeeper.io/) [![Build Status](https://travis-ci.org/opencomponents/oc-plugin-jwt.svg?branch=master)](https://travis-ci.org/opencomponents/oc-plugin-jwt)
+
+
+[OpenComponents](https://github.com/opentable/oc) plugin for validating [JSON Web Token (JWT)](https://tools.ietf.org/html/rfc7519) inside OC components.
+
+## Requirements
+* Node version: min **6**
+* [OC Registry](https://github.com/opentable/oc)
+
+## Install
+
+```bash
+npm i oc-plugin-jwt --save
+```
+
+## Registry setup
+
+More info about integrating OC plugins: [here](https://github.com/opentable/oc/wiki/Registry#plugins)
+
+
+Registering using the simple in-memory keystore.
+
+```js
+const registry = oc.registry(configuration);
+
+registry.register(
+  {
+    name: 'jwtVerify',
+    register: require('oc-plugin-jwt').verify,
+    options: {
+      keys: {
+        'key-id-1': {
+          publicKey: fs.readFileSync('certificate.pem')
+        },
+        'key-id-2': {
+          secret: 'super-secret-password'
+        }
+      }
+    }
+  },
+  err => {
+    if (err) {
+      console.log('plugin initialisation failed:', err);
+    } else {
+      console.log('jwt verify now available');
+    }
+  }
+);
+
+registry.start(callback);
+```
+
+Or custom using a custom keystore
+```js
+const registry = oc.registry(configuration);
+
+registry.register(
+  {
+    name: 'jwtVerify',
+    register: require('oc-plugin-jwt').verify,
+    options: {
+      keyStore: {
+        getSecretOrPublicKey(keyId, callback) {
+          // Get the public key or secret by some method
+          return callback(null, key);
+        }
+      }
+    }
+  },
+  err => {
+    if (err) {
+      console.log('plugin initialisation failed:', err);
+    } else {
+      console.log('jwt verify now available');
+    }
+  }
+);
+
+registry.start(callback);
+```
+
+## Using it inside components
+
+Example for a component's server.js:
+
+```js
+module.exports.data = (context, callback) => {
+  const exampleToken =
+    'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6ImtleS1pZC0yIn0.' +
+    'eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.' +
+    'bQVxleqAX7NQzI_RkIPFVfTl44-iEY0UYPUBm10789o';
+  context.plugins.jwtVerify(exampleToken, (error, verifiedToken) => {
+    if (error) {
+      // Handle token verification errors
+      callback(error);
+    }
+    callback(null, { verifiedToken: verifiedToken });
+  });
+};
+```
+
+## Generating Tokens
+
+* [See Here](https://github.com/opencomponents/oc-plugin-jwt-examples)

index.js

@@ -0,0 +1,3 @@
+'use strict';
+
+module.exports.verify = require('./lib/verify');

lib/__snapshots__/verify.test.js.snap

@@ -0,0 +1,33 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`verify when a key is not found in the keystore it returns an error with no token 1`] = `[Error: Key no-key not found]`;
+
+exports[`verify when a using a custom keystore returns the verified token with no errors 1`] = `
+Object {
+  "admin": true,
+  "name": "John Doe",
+  "sub": "1234567890",
+}
+`;
+
+exports[`verify when given a string that is not a token it returns an error with no token 1`] = `[Error: Invalid Token]`;
+
+exports[`verify when given a token that has been tampered with it returns an error with no token 1`] = `[JsonWebTokenError: invalid signature]`;
+
+exports[`verify when given a token that is missing the key id it returns an error with no token 1`] = `[Error: Token missing key id (kid) in header]`;
+
+exports[`verify when given a valid public key signed token returns the verified token with no errors 1`] = `
+Object {
+  "admin": true,
+  "name": "John Doe",
+  "sub": "1234567890",
+}
+`;
+
+exports[`verify when given a valid secret signed token returns the verified token with no errors 1`] = `
+Object {
+  "admin": true,
+  "name": "John Doe",
+  "sub": "1234567890",
+}
+`;