Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
42 changes: 25 additions & 17 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
@@ -1,30 +1,38 @@
# Javascript Node CircleCI 2.0 configuration file
#
# Check https://circleci.com/docs/2.0/language-javascript/ for more details
#
version: 2
jobs:
build:
docker:
# specify the version you desire here
- image: circleci/node:8.4

- image: circleci/node
steps:
# Checkout repository
- checkout

# Download and cache dependencies
# Restore cache
- restore_cache:
keys:
- v1-dependencies-{{ checksum "package.json" }}
# fallback to using the latest cache if no exact match is found
- v1-dependencies-
key: yarn-cache-{{ checksum "yarn.lock" }}

- run: yarn install
# Install dependencies
- run:
name: Install Dependencies
command: NODE_ENV=dev yarn

# Keep cache
- save_cache:
key: yarn-cache-{{ checksum "yarn.lock" }}
paths:
- node_modules
key: v1-dependencies-{{ checksum "package.json" }}
- "node_modules"

# Lint
- run:
name: Lint
command: yarn lint

# Tests
- run:
name: Tests
command: yarn jest

# run tests!
- run: yarn test
# Coverage
- run:
name: Coverage
command: yarn codecov
13 changes: 4 additions & 9 deletions .eslintrc.js
100755 → 100644
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
module.exports = {
root: true,
parserOptions: {
parser: 'babel-eslint',
sourceType: 'module'
},
env: {
Expand All @@ -14,17 +15,11 @@ module.exports = {
'vue'
],
rules: {
// Allow paren-less arrow functions
'arrow-parens': 0,
// Allow async-await
'generator-star-spacing': 0,
// Allow debugger during development
'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0,
// Do not allow console.logs etc...
'no-console': 2
'no-debugger': 1,
'no-console': 1
},
globals: {
'jest/globals': true,
jasmine: true
'jest/globals': true
}
}
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@ node_modules
*.log*
.nuxt
.vscode
.DS_STORE
.DS_Store
coverage
dist
dist
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@

// With options
['nuxt-csrf', {
sessionName: 'myCSRFSession',
sessionName: 'myCSRFSession',
secretKey: process.env.SECRET_KEY,
headerName: 'X-MY-CSRF-HEADER'
}],
]
}
```
```
12 changes: 12 additions & 0 deletions babel.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
module.exports = {
presets: [
[
'@babel/preset-env', {
targets: {
esmodules: true,
node: 'current'
}
}
]
]
}
6 changes: 5 additions & 1 deletion test/fixture/nuxt.config.js → example/nuxt.config.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
const { resolve } = require('path')

module.exports = {
rootDir: resolve(__dirname, '..'),
buildDir: resolve(__dirname, '.nuxt'),
srcDir: __dirname,
dev: false,
render: {
resourceHints: false
},
modules: [
'@@'
{ handler: require('../') }
],
csrf: {
sessionName: 'nuxtSession',
Expand Down
4 changes: 2 additions & 2 deletions test/fixture/pages/index.vue → example/pages/index.vue
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<template>
<div>
<div>
token: {{ token }}
</div>
</div>
</template>

<script>
Expand Down
3 changes: 3 additions & 0 deletions example/store/csrf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
export const state = () => ({
token: ""
})
11 changes: 8 additions & 3 deletions lib/module.js
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
const { resolve } = require('path')
const serverMiddleware = require('./server-middleware')

module.exports = async function module (moduleOptions) {
const options = Object.assign({}, moduleOptions, this.options.csrf)
module.exports = async function (moduleOptions) {
const options = {
...this.options['csrf'],
...moduleOptions
}

// Setup middleware
this.addServerMiddleware(serverMiddleware(options))

// Setup store
this.addPlugin({
src: resolve(__dirname, '../templates/plugin.js'),
src: resolve(__dirname, './plugin.js'),
fileName: 'nuxt-csrf.js',
options
})
Expand All @@ -19,3 +22,5 @@ module.exports = async function module (moduleOptions) {
this.options.router.middleware = this.options.router.middleware || []
this.options.router.middleware.push('csrf')
}

module.exports.meta = require('../package.json')
19 changes: 19 additions & 0 deletions lib/plugin.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
import middleware from '@/.nuxt/middleware'

const moduleName = 'csrf'

export default async function (context) {
const initStore = context => {
if (process.client) return
context.store.registerModule(moduleName, {
namespaced: true,
state: {
token: (context.req && context.req.csrfToken)
}
})
}

middleware.csrf = async context => {
initStore(context)
}
}
46 changes: 24 additions & 22 deletions lib/server-middleware.js
Original file line number Diff line number Diff line change
Expand Up @@ -13,33 +13,35 @@ const createError = (code, message, original) => {
const tokens = new Tokens()
const safeMethods = /GET|HEAD|OPTIONS|TRACE/i

function CSRFSession({ sessionName, secretKey, headerName = 'x-csrf-token' }) {
function CSRFSession ({ sessionName, secretKey, headerName = 'x-csrf-token' }) {
this.sessionName = sessionName
this.secretKey = secretKey
this.headerName = headerName
}

CSRFSession.prototype.createSession = (req, res) => {
const session = sessions({
cookieName: this.sessionName,
secret: this.secretKey,
duration: 60 * 60 * 1000 // 60 mins
})
return new Promise(resolve => session(req, res, resolve))
}

CSRFSession.prototype.initCSRF = async (req, res) => {
await this.createSession(req, res, this.sessionName)
const secret = req[this.sessionName].csrfSecret || await tokens.secret()
req.csrfToken = tokens.create(secret)
req[this.sessionName].csrfSecret = secret
return secret
}

CSRFSession.prototype.verify = (req) => {
const token = req.headers[this.headerName]
const { csrfSecret: secret } = req[this.sessionName]
return tokens.verify(secret, token)
CSRFSession.prototype = {
createSession (req, res) {
const session = sessions({
cookieName: this.sessionName,
secret: this.secretKey,
duration: 60 * 60 * 1000 // 60 mins
})
return new Promise(resolve => session(req, res, resolve))
},

async initCSRF (req, res) {
await this.createSession(req, res, this.sessionName)
const secret = req[this.sessionName].csrfSecret || await tokens.secret()
req.csrfToken = tokens.create(secret)
req[this.sessionName].csrfSecret = secret
return secret
},

verify (req) {
const token = req.headers[this.headerName]
const { csrfSecret: secret } = req[this.sessionName]
return tokens.verify(secret, token)
}
}

module.exports = options => async (req, res, next) => {
Expand Down
17 changes: 0 additions & 17 deletions lib/templates/plugin.js

This file was deleted.

46 changes: 37 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "nuxt-csrf",
"version": "0.0.0",

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this package is at 1.0 yet—it would be misleading to suggest it's been battle tested for a stable release.

"version": "1.0.0",
"description": "Add some good old CSRF to your Nuxt app",
"license": "MIT",
"contributors": [
Expand All @@ -14,30 +14,58 @@
"access": "public"
},
"scripts": {
"dev": "nuxt example",
"lint": "eslint lib test",
"test": "npm run lint && jest",
"release": "standard-version && git push --follow-tags && npm publish"
},
"eslintIgnore": [
"lib/templates/*.*"
"node_modules",
".nuxt",
"lib/plugin.js"
],
"files": [
"lib"
],
"jest": {
"testEnvironment": "node",
"coverageDirectory": "./coverage/",
"collectCoverage": true,
"collectCoverageFrom": [
"lib",
"test"
]
"collectCoverage": false,
"moduleNameMapper": {
"^~/(.*)$": "<rootDir>/lib/$1",
"^~~$": "<rootDir>",
"^@@$": "<rootDir>",
"^@/(.*)$": "<rootDir>/example/$1"
},
"transform": {
"^.+\\.js$": "<rootDir>/node_modules/babel-jest",
".*\\.(vue)$": "<rootDir>/node_modules/vue-jest"
}
},
"dependencies": {
"client-sessions": "^0.8.0",
"csrf": "^3.0.6"
},
"devDependencies": {
"nuxt-module-builder": "latest"
"@babel/core": "latest",
"@babel/preset-env": "latest",
"@nuxtjs/eslint-config": "latest",
"babel-eslint": "latest",
"babel-jest": "latest",
"codecov": "latest",
"eslint": "latest",
"eslint-config-standard": "latest",
"eslint-plugin-import": "latest",
"eslint-plugin-jest": "latest",
"eslint-plugin-node": "latest",
"eslint-plugin-promise": "latest",
"eslint-plugin-standard": "latest",
"eslint-plugin-vue": "latest",
"get-port": "latest",
"jest": "latest",
"node-fetch": "^2.3.0",
"nuxt-edge": "^2.6.0-25901287.3eec1152",
"request": "latest",
"standard-version": "latest",
"vue-jest": "latest"
}
}
5 changes: 5 additions & 0 deletions renovate.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"extends": [
"@nuxtjs"
]
}
Loading