https://github.com/baroshem/nuxt-security

🛡 Automatically configure your app to follow OWASP security patterns and principles by using HTTP Headers and Middleware
https://github.com/baroshem/nuxt-security

basic-authentication cors csrf headers-security module nonce nuxt owasp rate-limiting security vue xss

Last synced: about 2 months ago
JSON representation

🛡 Automatically configure your app to follow OWASP security patterns and principles by using HTTP Headers and Middleware

• Host: GitHub
• URL: https://github.com/baroshem/nuxt-security
• Owner: Baroshem
• License: mit
• Created: 2022-10-08T13:27:30.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-10-25T09:41:13.000Z (3 months ago)
• Last Synced: 2024-10-29T14:51:06.148Z (3 months ago)
• Topics: basic-authentication, cors, csrf, headers-security, module, nonce, nuxt, owasp, rate-limiting, security, vue, xss
• Language: TypeScript
• Homepage: https://nuxt-security.vercel.app/
• Size: 4.73 MB
• Stars: 816
• Watchers: 4
• Forks: 56
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
[![nuxt-security](https://nuxt-security.vercel.app/preview.png)](https://nuxt-security.vercel.app)

[![npm version][npm-version-src]][npm-version-href]

[![npm downloads][npm-downloads-src]][npm-downloads-href]

[![Github Actions CI][github-actions-ci-src]][github-actions-ci-href]

[![License][license-src]][license-href]

[![Nuxt][nuxt-src]][nuxt-href]

# Nuxt Security

Automatically configure your app to follow OWASP security patterns and principles by using HTTP Headers and Middleware.

> This module works with Nuxt 3 only

- [📖  Read the documentation](https://nuxt-security.vercel.app)

- [👾  Playground](https://nuxt-security.vercel.app/playground)

## Features

- Security response headers (including CSP for SSG apps)

- Request Size & Rate Limiters

- Cross Site Scripting (XSS) Validation

- Cross-Origin Resource Sharing (CORS) support

- Hide `X-Powered-By` header and remove console loggers utils

- `[Optional]` Allowed HTTP Methods, Basic Auth, CSRF

## Usage

Install the module:

```sh

npx nuxi@latest module add security

```

And that's it! The module will now register route rules and server middlewares globally so that your application will be more secured.

## Configuration

You can pass configuration to the module in the `nuxt.config.ts` like following:

```ts

export default defineNuxtConfig({

  modules: ["nuxt-security"],

  security: {

    // options

  }

})

```

For all available configuration options check out the [docs](https://nuxt-security.vercel.app).

## Development

- Run `yarn dev:prepare` to generate type stubs.

- Use `yarn dev` to start playground in development mode.

## License

[MIT License](./LICENSE)

[npm-version-src]: https://img.shields.io/npm/v/nuxt-security/latest.svg

[npm-version-href]: https://npmjs.com/package/nuxt-security

[npm-downloads-src]: https://img.shields.io/npm/dt/nuxt-security.svg

[npm-downloads-href]: https://npmjs.com/package/nuxt-security

[github-actions-ci-src]: https://github.com/baroshem/nuxt-security/actions/workflows/ci.yml/badge.svg

[github-actions-ci-href]: https://github.com/baroshem/nuxt-security/actions?query=workflow%3Aci

[license-src]: https://img.shields.io/npm/l/nuxt-security.svg

[license-href]: https://npmjs.com/package/nuxt-security

[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js

[nuxt-href]: https://nuxt.com