@nitra/cf-security 1.0.6 → 3.0.0

package/README.md

@@ -1,2 +1,19 @@
 # cf-security
-Check security header in CF
+
+[![GitHub Super-Linter](https://github.com/nitra/cf-security/workflows/npm-publish/badge.svg)](https://github.com/marketplace/actions/super-linter)
+
+Check security header in Cloud Functions
+
+```HTTP
+X_NITRA_CF_KEY: secret
+```
+
+```JavaScript
+const { cfSecurity } = require('@nitra/cf-security')
+
+exports.function = async (req, res) => {
+  if (!cfSecurity(req)) {
+    res.send(`Nitra security not passed`)
+    return
+  }
+```

package/package.json

@@ -1,21 +1,12 @@
 {
   "name": "@nitra/cf-security",
-  "version": "1.0.6",
+  "version": "3.0.0",
   "description": "check header in cloud functions",
   "main": "src/index.js",
-  "@pika/pack": {
-    "pipeline": [
-      [
-        "@pika/plugin-standard-pkg"
-      ],
-      [
-        "@pika/plugin-build-node"
-      ]
-    ]
-  },
+  "type": "module",
   "scripts": {
-    "fix": "standard --fix",
-    "version": "npx @pika/pack build"
+    "fix": "npx standard --fix && npx prettier --write .",
+    "test": "env $(cat ./test/.env) npx coverage-node test/index.js"
   },
   "repository": {
     "type": "git",
@@ -27,16 +18,13 @@
     "url": "https://github.com/nitra/cf-security/issues"
   },
   "homepage": "https://github.com/nitra/cf-security#readme",
+  "prettier": "prettier-config-standard",
   "devDependencies": {
-    "@pika/cli": "^0.2.0",
-    "@pika/pack": "^0.5.0",
-    "@pika/plugin-build-node": "^0.6.0",
-    "@pika/plugin-standard-pkg": "^0.6.0",
-    "@types/node": "^12.7.4",
-    "standard": "^14.1.0"
+    "prettier-config-standard": "^1.0.1",
+    "test-director": "^7.0.0"
   },
   "dependencies": {
-    "@47ng/check-env": "^1.3.1",
-    "loglevel-colored-level-prefix": "^1.0.0"
+    "@nitra/check-env": "^2.0.1",
+    "@nitra/consola": "^1.3.1"
   }
 }

package/src/index.js

@@ -1,42 +1,31 @@
-/**
- * CF Security module
- * @module @nitra/cf-security
- */
+import consola from '@nitra/consola'
+import checkEnv from '@nitra/check-env'
+checkEnv(['X_NITRA_CF_KEY'])
 
 /**
- * @const {Function}
+ * Check request for Nitra security rules
+ *
+ * @param {object} req - ApolloServer or Express Request for check
+ * @return {boolean} if check passed
  */
-const checkEnv = require('@47ng/check-env').default
-checkEnv({ required: ['X_NITRA_CF_KEY'] })
-
-const log = require('loglevel-colored-level-prefix')()
-log.debug('cfSecurity in DEBUG MODE')
-
-/**
-* Check request for Nitra security rules
-*
-* @param {object} req - ApolloServer or Express Request for check
-* @return {boolean} if check passed
-*/
-
-exports.cfSecurity = function (req) {
+export const cfSecurity = req => {
   if (typeof req.headers === 'undefined') {
-    log.debug('Request without headers')
+    consola.debug('Request without headers')
     return false
   }
 
-  if (typeof req.headers.x_nitra_cf_key === 'undefined') {
-    log.debug('Nitra key not exist in request')
+  if (typeof req.headers['x-nitra-cf-key'] === 'undefined') {
+    consola.debug('Nitra key not exist in request')
     return false
   }
 
-  if (req.headers.x_nitra_cf_key.length === 0) {
-    log.debug('Empty Nitra key in headers request')
+  if (req.headers['x-nitra-cf-key'] === 0) {
+    consola.debug('Empty Nitra key in headers request')
     return false
   }
 
-  if (req.headers.x_nitra_cf_key !== process.env.X_NITRA_CF_KEY) {
-    log.debug('Not equal Nitra key')
+  if (req.headers['x-nitra-cf-key'] !== process.env.X_NITRA_CF_KEY) {
+    consola.debug('Not equal Nitra key')
     return false
   }