Merge pull request #45 from Baroshem/chore/0.6.0

Chore/0.6.0

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Baroshem <[email protected]>
+
+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

@@ -81,7 +81,7 @@ For all available configuration options check out the [docs](https://nuxt-securi
 ## Development
 
 - Run `npm run dev:prepare` to generate type stubs.
-- Use `npm run dev` to start [playground](./playground) in development mode.
+- Use `npm run dev` to start playground in development mode.
 
 ## License
 

docs/content/3.good-practices/1.hide-x-powered-by-header.md

@@ -7,7 +7,7 @@ description: ''
 
 You can read more about this recommendation [here](https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html#use-appropriate-security-headers)
 
-Fortunately, `nuxt-security` module replaces automatically the default value for this header to text `Best Framework Ever` so your application is not leaking this information in the response headers.
+Fortunately, `nuxt-security` module hides this header by default so your application is not leaking this information in the response headers.
 
 However, if you prefer not to have this changed, you can always disable this functionality from the module configuration (which is not recommended but possible) like the following:
 

docs/content/3.good-practices/3.use-eslint-security-plugin.md

@@ -5,7 +5,7 @@ description: ''
 
 ESLint plugin containing Node.js security rules. This plugin will help to identify potential threats and prevent attacks.
 
-you can read more about it [here](https://www.npmjs.com/package/eslint-plugin-security-node).
+You can read more about it [here](https://www.npmjs.com/package/eslint-plugin-security-node).
 
 Install the module:
 

docs/content/3.good-practices/4.use-access-control-lists.md

@@ -0,0 +1,27 @@
+---
+title: Use access control lists
+description: ''
+---
+
+Authorization prevents users from acting outside of their intended permissions. In order to do so, users and their roles should be determined with consideration of the principle of least privilege. Each user role should only have access to the resources they must use. 
+
+You can use the `acl` module to provide ACL (access control list) implementation. With this module, you can create roles and assign users to these roles.
+
+You can read more about it [here](https://www.npmjs.com/package/acl).
+
+Install the module:
+
+```bash
+npm install acl # or yarn
+```
+
+Add use it in your code:
+
+```ts
+var acl = require('acl');
+
+acl = new acl(new acl.memoryBackend())
+
+// guest is allowed to view blogs
+acl.allow('guest', 'blogs', 'view')
+```

docs/content/3.good-practices/5.perform-application-activity-logging.md

@@ -0,0 +1,26 @@
+---
+title: Perform Application Activity Logging
+description: ''
+---
+
+Logging application activity is an encouraged good practice. It makes it easier to debug any errors encountered during application runtime. It is also useful for security concerns, since it can be used during incident response. In addition, these logs can be used to feed Intrusion Detection/Prevention Systems (IDS/IPS).
+
+You can read more about it [here](https://cheatsheetseries.owasp.org/cheatsheets/Nodejs_Security_Cheat_Sheet.html#perform-application-activity-logging).
+
+Install the module:
+
+```bash
+npm i winston # or yarn
+```
+
+Add then use it in your application like this:
+
+```js
+const logger = new (Winston.Logger) ({
+  transports: [
+      new (winston.transports.Console)(),
+      new (winston.transports.File)({ filename: 'application.log' })
+  ],
+  level: 'verbose'
+});
+```

package.json

@@ -1,9 +1,12 @@
 {
   "name": "nuxt-security",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "license": "MIT",
   "type": "module",
   "homepage": "https://nuxt-security.vercel.app",
+  "repository": {
+    "url": "https://github.com/Baroshem/nuxt-security"
+  },
   "exports": {
     ".": {
       "import": "./dist/module.mjs",

src/module.ts

@@ -1,5 +1,5 @@
-import { resolve } from 'path'
-import { fileURLToPath } from 'url'
+import { resolve, normalize } from 'pathe'
+import { fileURLToPath } from 'node:url'
 import { defineNuxtModule, addServerHandler } from '@nuxt/kit'
 import defu from 'defu'
 import { AllowedHTTPMethods, MiddlewareConfiguration, ModuleOptions, RateLimiter, RequestSizeLimiter, SecurityHeaders, XssValidator } from './types'
@@ -25,7 +25,7 @@ export default defineNuxtModule<ModuleOptions>({
     if (nuxt.options.security.hidePoweredBy) {
       nuxt.hook('nitro:config', (config) => {
         config.plugins = config.plugins || []
-        config.plugins.push(fileURLToPath(new URL('./runtime/nitro', import.meta.url)))
+        config.plugins.push(normalize(fileURLToPath(new URL('./runtime/nitro', import.meta.url))))
       })
     }
 

src/runtime/nitro.ts

@@ -2,6 +2,6 @@ import type { NitroAppPlugin, RenderResponse } from 'nitropack'
 
 export default <NitroAppPlugin> function (nitro) {
   nitro.hooks.hook('render:response', (response: RenderResponse) => {
-    response.headers = { ...response.headers, 'X-Powered-By': 'Best Framework Ever' }
+    delete response.headers['X-Powered-By']
   })
 }