Skip to content

Releases: Baroshem/nuxt-security

1.4.0

26 Apr 06:51
@Baroshem Baroshem
v1.4.0
15142c0
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.4.0 Latest
Latest

1.4.0 🎉

This version is a significant rewrite of the core engine of Nuxt Security, motivated primarily by the introduction of runtime hooks in PR #298 by @huang-julien and comments thereon by @harlan-zw.

Huge kudos to @vejja for delivering this great functionality 💚

Full Route-Level Compatibility

This great addition by Sebastien is well detailed here #429 but as short summary can be seen below.

New features

  • All security options can now be modified via runtime hooks
    It is now possible to modify any of the Nuxt Security options, and not solely the headers : any other option such as hidePoweredBy, rateLimiter, is now taken into consideration and applied at route level.

  • Route rules are now consistently merged
    The router merging strategy is now the same irrespective of the way the security options are set (inline, global, routeRules, and runtime hooks). Previously, it was a mix of defu, defuReplaceArray, and plain overwriting - leading to confusion on how nested rules would apply (see #430 for instance). We now apply the defuReplaceArray strategy across the board.

  • Clear scoping of security headers to HTML pages, SWR support
    We now make a clearer distinction between the scope of Nitro plugins (modifying HTML pages and their headers) and the scope of Server middlewares (functions that apply to all routes). This avoids to overwrite headers of non-HTML assets with irrelevant options, and as a result we are able to support SWR natively.

  • Route-level support of RateLimiter
    Thanks to the ability to resolveSecurityRoutes at runtime, we are now able to support route-based definitions for the Rate Limiter. This solves the issue of getting 429 denials for routes where we want to have a higher rate limit. We also take this opportunity to solve the issue of getting 429s when pre-rendering.

New runtime hook

This PR introduces a new runtime hook : nuxt-security:routeRules, that allows to modify any security rule on any route. With this hook, the user is now able to apply any strategy for the rule (merge, overwrite, append, etc.).

nitroApp.hooks.hook('nuxt-security:routeRules', async routeRules => {
  // any kind of modification of routeRules here, such as :
  routeRules['/my-route'] = ...
 })

The former nuxt-security:ready & nuxt-security:headers hooks are still supported but we are soft-depecrating them by removing them from the documentation.

Additional notes

This version also soft-deprecates the substitution merging via string syntax feature. This is now rendered unnecessary because the defuReplaceArray strategy is applied consistently everywhere.

We are removing corresponding mentions in the documentation, which were confusing (it only applied to headers, and it only applied in the router merging step but not in the definition step). The feature still exists to maintain backwards compatibility.

Please note that some security options can only be applied globally (removeLoggers, csrf and basicAuth) because they depend on third-party modules. The TypeScript definitions have been updated to remove these 3 options from the properties that can be set at route-level.

🗞️ Next steps

We are planning a new release soon with the Nuxt DevTools Tab support 🚀

👉 Changelog
compare changes

❤️ Contributors

What's Changed

  • Vejja/issue413 by @vejja in #414
  • update(doc): recommend useScript for Nuxt 3.11+ by @vejja in #403
  • chore: bump unplugin-remove to fix sourcemap warnings by @Jesse1989pp in #420
  • Update 1.csp.md - FIX comparison in docs by @Dominic-Marcelino in #424
  • Fixed small typo found in the documentation by @snepsnepy in #431
  • feat(core): unified router context by @vejja in #429
  • Closes #269 : Rate Limiter is now disabled when building with SSG
  • Closes #281 : Rate Limiter now records requests at the route level
  • Closes #300: All security options are now configurable via the new runtime hook
  • Closes #385 : All security options are now resolved with the same merging strategy
  • Closes #392 : Rate Limiter now supports any endpoint, including /api routes
  • Closes #428 : SWR is now natively supported
  • Closes #430 : There is no need to use string syntax anymore to overwrite higher-level rules
  • Closes #432 : The function insertNonceInCsp now correctly handles boolean value for CSP directives

Contributors

harlan-zw, Jesse1989pp, and 4 other contributors
Assets 2

v1.3.0

03 Apr 16:12
@Baroshem Baroshem
v1.3.0
d0a3c3f
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
v1.3.0

1.3.0 🎉

This version brings several bugfixes and small new features.

Kudos to all contributors! 💚

🗞️ Next steps

We are already planning a release 1.3.0 that will include support for rate limiter global and per route as well as protecting api 🚀

👉 Changelog
compare changes

🚀 Enhancements

  • fetch buffers from storage and convert to object
  • enhance FormData with XSS validation feature

🩹 Fixes

  • remove frame-ancestors from meta
  • generate meta tag without html,head,body tags
  • do not decode entities in HTML
  • opt in to import.meta.* properties
  • set nonce in response headers instead of using configuration

📖 Documentation

  • use new nuxi module add command in installation

🏡 Chore

🤖 CI

❤️ Contributors

What's Changed

  • fix(ssg): remove frame-ancestors from meta by @vejja in #388
  • fix(ssg): generate meta tag without html,head,body tags by @mtdvlpr in #387
  • fix(core): do not decode entities in HTML by @vejja in #394
  • sri: fetch buffers from storage and convert to object by @vejja in #396
  • Enhance FormData with XSS validation feature. by @Ray0907 in #401
  • fix: opt in to import.meta.* properties by @danielroe in #406
  • fix: set nonce in response headers instead of using configuration by @huang-julien in #408
  • docs: use new nuxi module add command in installation by @danielroe in #410
  • Chore/1.3.0 by @Baroshem in #399

Contributors

vejja, danielroe, and 4 other contributors
Assets 2

1.2.0

22 Feb 07:25
@Baroshem Baroshem
v1.2.0
35d2352
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.2.0

1.2.0 🎉

This version brings several bugfixes and small new features mostly related to XSS Validator.

Kudos to all contributors! 💚

🗞️ Next steps

We are already planning a release 1.3.0 that will include support for DevTools 🚀

👉 Changelog
compare changes

🚀 Enhancements

  • add escapeHtml option to XssValidator
  • allow users to configure methods for XSSValidator
  • disable meta tag for SSG mode

🩹 Fixes

  • add explicit imports for setHeader and removeResponseHeader in 00-context.ts
  • move middleware logic to beforeResponse

📖 Documentation

  • fix the example for runtime hooks
  • handling state with care
  • add favicon fix

🏡 Chore

🤖 CI

❤️ Contributors

What's Changed

Contributors

scottix, vejja, and 5 other contributors
Assets 2

1.1.0

01 Feb 12:22
@Baroshem Baroshem
v1.1.0
11dc2d5
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Learn about vigilant mode.
Compare
Choose a tag to compare
1.1.0

1.1.0 🎉

1.1.0 is the first minor release for a stable 1.0.0 version

The biggest feature of this version is a support for runtime config by @huang-julien ❤️ Take a look at below instructions to understand how to use it in your app.

If you need to change the headers configuration at runtime, it is possible to do it through nuxt-security:headers hook.

Enabling the option

This feature is optional, you can enable it with

export default defineNuxtConfig({
    modules: ['nuxt-security'],
    security: {
        runtimeHooks: true
    }
})

Within your nitro plugin. You can override the previous configuration of a route with nuxt-security:headers.

export default defineNitroPlugin((nitroApp) => {
    nitroApp.hooks.hook('nuxt-security:ready', () => {
        nitroApp.hooks.callHook('nuxt-security:headers', '/**' ,{
            contentSecurityPolicy: {
                "script-src": ["'self'", "'unsafe-inline'"],
            },
            xFrameOptions: false
        })
    })
})

And also, huge kudos to all contributors 🎉

🗞️ Next steps

We are already planning a release 1.2.0 with additional cool features. Stay tuned! 🚀

👉 Changelog
compare changes

🚀 Enhancements

  • allow configuring headers in runtime
  • improving performance for SSG apps by cheerio optimizations

🩹 Fixes

  • disable 05-cspSsgPresets

📖 Documentation

  • correct default for crossOriginEmbedderPolicy
  • add new video and introduction page
  • add favicon fix

🏡 Chore

🤖 CI

❤️ Contributors

What's Changed

New Contributors

Contributors

dargmuesli, vejja, and 5 other contributors
Assets 2

1.0.0

13 Dec 09:38
@Baroshem Baroshem
v1.0.0
a6b9c02
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0

1.0.0 🎉

1.0.0 is the stable release

After five release candidate versions, we are now ready to present you a stable 1.0.0 release of NuxtSecurity. We have spent a lot of time trying to stabilise the API while constantly improving the security by implementing features like:

  • Strict Content Security Policy
  • Improved Rate Limiter
  • Subresource Integrity
  • Nonce
  • Per route Security headers configuration
  • Documentation about improving security of your Nuxt app

From this point I would like to thank @vejja who did an amazing work delivering a lot of functionalities mentioned both above and below. You are a magician! 🚀

And also, huge kudos to all contributors 🎉

✅ Migration Guide (0.14.X -> 1.0.0)

We have tried our best not to include significant breaking changes in the recent stable 1.0.0 version but some changes were necessary to improve quality of the module. Don't worry, we have prepared a migration guide with all the changes and how you should approach when migrating your current application to be up to date with 1.0.0 :)

1. Modifed the structure for alllowedMethodsRestricter

In the previous version, alllowedMethodsRestricter was an array of HTTP methods or '*' for all methods.

export default defineNuxtConfig({
  security: {
    allowedMethodsRestricter: ['GET']
  }
}

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    allowedMethodsRestricter: {
      methods: ['GET'],
      throwError?: true,
    }
  }
}

This change allows to pass a throwError property that can be useful to return an error response rather than throwing a default Nuxt error.

2. Changed the disabled value for permissionsPolicy

In the previous version, if you wanted to disable certain API like camera you would do something like this:

export default defineNuxtConfig({
  security: {
    headers: {
      permissionsPolicy: {
        'camera': [()]
      },
    },
  },
})

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    headers: {
      permissionsPolicy: {
        'camera': [] // This will block usage of camera by this website
      },
    },
  },
})

This change allows to fix an issue of passing several directives mentioned in #194

3. Changed the type of interval in rateLimiter

In the previous version, if you wanted to set the interval for your rateLimiter you would do something like this:

export default defineNuxtConfig({
  security: {
    rateLimiter: {
      interval: 'hour' | 60000
    }
  }
})

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    rateLimiter: {
      interval: 60000
    }
  }
})

This change was required to migrate to an updated rateLimiter that supports modern examples.

4. Nonce value

In the previous version, nonce could be either an object with a type NonceOptions or false.

export type NonceOptions = {
  enabled: boolean;
  mode?: 'renew' | 'check';
  value?: (() => string);
}

Now it is only a boolean value:

export default defineNuxtConfig({
  security: {
    nonce: true | false
  }
}

This change was necessary to resolve security vulnerability for nonce reported by vejja #257. Read more about the new usage of nonce in this module https://nuxt-security.vercel.app/documentation/headers/csp#nonce

5. Strict Content Security Policy by default

In this version, we have updated ContentSecurityConfiguration by a mile, specifically we have enabled strict CSP by default to spread good security practices.

If you are experiencing some issues with CSP, check out the new documentation about it:

  1. Basic CSP usage -> https://nuxt-security.vercel.app/documentation/headers/csp
  2. Advanced & Strict CSP -> https://nuxt-security.vercel.app/documentation/advanced/strict-csp

🍾 New features

This PR introduces per-route configuration of security headers, via

defineNuxtConfig({
  routeRules: {
    [some-route]: {
      security: {
        headers : ...
      }
    }
  }
})

🗞️ Next steps

This is the last release candidate version. In the next weeks we are planning to release stable 1.0.0 version :)

👉 Changelog
compare changes

🚀 Enhancements

  • move logic of Static plugins to the top of module.ts to decrease the amount of code for SSG apps
  • improve rateLimiter with support for unstorage (#190)
  • remove console.logs after build (#128)
  • add an include option for basicAuth (#219)
  • option to disable hashing for SSG (#215)
  • support for CRSF in Serverless Environments
  • Add credentialless value to Cross-Origin-Embedder-Policy header
  • Export configuration type
  • Improve CSP Compliance
  • ensure csp plugins are added last
  • Extend CSP support of SSG mode
  • use cheerio HTML parser for CSP
  • hashStyles option
  • Strict CSP by default
  • SRI hashes for SSG mode
  • Subresource Integrity
  • Per-route object based headers configuration
  • Limiting CSP header to HTML responses only
  • Migrate to Node 18.X
  • Allow falling back to global options when per-route option is not provided

🩹 Fixes

  • useCsrf() is undefined (#203)
  • CSRF tokens cause breakage on build using serverless environments due to incompatible exports of Node Crypto (#167)
  • upgrade-insecure-requests cannot be turned off for static build (#214)
  • invalid permission policy parser (#194)
  • remove broken test for nonce (#213)
  • Basic Auth Configuration for Multiple Paths
  • Nonce value is injected in all pre-rendered pages if the nonce option is set to true
  • failed to find a valid digest in the 'integrity' attribute
  • Strict-Transport-Security as string not parsing max-age correctly
  • Nuxt 3.8.1 breaks Subresource Integrity
  • Unrecognized Content-Security-Policy directive 'undefined'
  • Build fails because of removeLoggers
  • allow csp value to be false

📖 Documentation

  • refactor docs to be easier (#135)
  • create faq section in docs from questions in Github issues (#192)
  • security composable to use in pages (#217)
  • Content-Security-Policy: The page’s settings blocked the loading of a resource at inline (#218)
  • custom CSP merger (#198)
  • stripe blocked by 'Cross-Origin-Embedder-Policy' (#229)
  • update 3.rate-limiter.md fix comma (#204)
  • New section for Contributing
  • New section for Usage
  • Reorganised Navigation
  • Added global Search
  • New Homepage
  • New section for Headers
  • New section for utils
  • Embedded Playground
  • New page for Releases
  • Migrated to newest docus
  • New Preview Image
  • Per Route Security configuration with headers
  • Clarify rateLimiter interval property
  • Advanced documentation about Content Security Policy
  • Cross-Origin-Resource-Policy header Error on Paypal Checkout -> FAQ

🏡 Chore

  • remove legacy approach for middlewares in types and module.ts file (#191)
  • bump packages to newer versions (#183) -> Nuxt 3.2 -> 3.7
  • Reorganized project repository for easier maintenance
  • specify package manager (#225)
  • do not use default export for defu (#224)
  • Improve TS config

🤖 CI

  • improved CI script for automatic unit tests for main, rc, and renovate branches

❤️ Contributors

What's Changed

Read more

Contributors

Tristan971, Atinux, and 19 other contributors
Assets 2
0 Join discussion

1.0.0-rc.5

05 Dec 09:55
@Baroshem Baroshem
v1.0.0-rc.5
b945040
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0-rc.5 Pre-release
Pre-release

1.0.0-rc.5 is the next release candidate

🍾 New features

This PR introduces per-route configuration of security headers, via

defineNuxtConfig({
  routeRules: {
    [some-route]: {
      security: {
        headers : ...
      }
    }
  }
})

🗞️ Next steps

This is the last release candidate version. In the next weeks we are planning to release stable 1.0.0 version :)

👉 Changelog
compare changes

🚀 Enhancements

  • Per-route object based headers configuration
  • Limiting CSP header to HTML responses only
  • Migrate to Node 18.X
  • Allow falling back to global options when per-route option is not provided

🩹 Fixes

  • failed to find a valid digest in the 'integrity' attribute
  • Strict-Transport-Security as string not parsing max-age correctly
  • Nuxt 3.8.1 breaks Subresource Integrity
  • Unrecognized Content-Security-Policy directive 'undefined'
  • Build fails because of removeLoggers

📖 Documentation

  • Per Route Security configuration with headers

❤️ Contributors

Contributors

vejja
Assets 2

1.0.0-rc.4

15 Nov 10:18
@Baroshem Baroshem
v1.0.0-rc.4
8370a8a
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0-rc.4 Pre-release
Pre-release

1.0.0-rc.4 is the next release candidate

🗞️ Next steps

We are planning to release one or two more release candidate versions before a stable 1.0.0 version will be released.

✅ Migration Guide

This version may include ⚠️ breaking changes but don't worry, we have prepared migration guide for you 😉

In this version, we have updated ContentSecurityConfiguration by a mile, specifically we have enabled strict CSP by default to spread good security practices.

If you are experiencing some issues with CSP, check out the new documentation about it:

  1. Basic CSP usage -> https://nuxt-security.vercel.app/documentation/headers/csp
  2. Advanced & Strict CSP -> https://nuxt-security.vercel.app/documentation/advanced/strict-csp

👉 Changelog
compare changes

🚀 Enhancements

  • hashStyles option
  • Strict CSP by default
  • SRI hashes for SSG mode
  • Subresource Integrity

🩹 Fixes

  • allow csp value to be false

📖 Documentation

  • Advanced documentation about Content Security Policy
  • Cross-Origin-Resource-Policy header Error on Paypal Checkout -> FAQ

⚠️ Breaking Changes

  • Strict CSP

❤️ Contributors

Contributors

dargmuesli, vejja, and geekyshow1
Assets 2

1.0.0-rc.3

01 Nov 18:14
@Baroshem Baroshem
v1.0.0-rc.3
7ef4988
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
1.0.0-rc.3 Pre-release
Pre-release

1.0.0-rc.3 is the next release candidate

🗞️ Next steps

We are planning to release one or two more release candidate versions with bugfixes before a stable 1.0.0 version will be released.

✅ Migration Guide

This version includes ⚠️ breaking changes but don't worry, we have prepared migration guide for you 😉

In the previous version, nonce could be either an object with a type NonceOptions or false.

export type NonceOptions = {
  enabled: boolean;
  mode?: 'renew' | 'check';
  value?: (() => string);
}

Now it is only a boolean value:

export default defineNuxtConfig({
  security: {
    nonce: true | false
  }
}

This change was necessary to resolve security vulnerability for nonce reported by vejja #257. Read more about the new usage of nonce in this module https://nuxt-security.vercel.app/documentation/headers/csp#nonce

👉 Changelog
compare changes

🚀 Enhancements

  • Add credentialless value to Cross-Origin-Embedder-Policy header
  • Export configuration type
  • Improve CSP Compliance
  • ensure csp plugins are added last
  • Extend CSP support of SSG mode
  • use cheerio HTML parser for CSP

🩹 Fixes

  • Basic Auth Configuration for Multiple Paths
  • Nonce value is injected in all pre-rendered pages if the nonce option is set to true

📖 Documentation

  • Clarify rateLimiter interval property

🏡 Chore

  • Improve TS config

⚠️ Breaking Changes

  • CSP Compliance

❤️ Contributors

🏋️‍♂️ New Contributors

Contributors

Tristan971, espensgr, and 3 other contributors
Assets 2
10 Join discussion

1.0.0-rc.1

18 Oct 16:15
@Baroshem Baroshem
v1.0.0-rc.1
9a53133
Compare
Choose a tag to compare
1.0.0-rc.1 Pre-release
Pre-release

1.0.0-rc.1 is the first release candidate

🗞️ Next steps

We are planning to release one or two more release candidate versions with bugfixes before a stable 1.0.0 version will be released.

✅ Migration Guide

This version includes ⚠️ breaking changes but don't worry, we have prepared migration guide for you 😉

Modifed the structure for alllowedMethodsRestricter

In the previous version, alllowedMethodsRestricter was an array of HTTP methods or '*' for all methods.

export default defineNuxtConfig({
  security: {
    allowedMethodsRestricter: ['GET']
  }
}

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    allowedMethodsRestricter: {
      methods: ['GET'],
      throwError?: true,
    }
  }
}

This change allows to pass a throwError property that can be useful to return an error response rather than throwing a default Nuxt error.

Changed the disabled value for permissionsPolicy

In the previous version, if you wanted to disable certain API like camera you would do something like this:

export default defineNuxtConfig({
  security: {
    headers: {
      permissionsPolicy: {
        'camera': [()]
      },
    },
  },
})

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    headers: {
      permissionsPolicy: {
        'camera': [] // This will block usage of camera by this website
      },
    },
  },
})

This change allows to fix an issue of passing several directives mentioned in #194

Changed the type of interval in rateLimiter

In the previous version, if you wanted to set the interval for your rateLimiter you would do something like this:

export default defineNuxtConfig({
  security: {
    rateLimiter: {
      interval: 'hour' | 60000
    }
  }
})

Now it is configured like following:

export default defineNuxtConfig({
  security: {
    rateLimiter: {
      interval: 60000
    }
  }
})

This change was required to migrate to an updated rateLimiter that supports modern examples.

👉 Changelog
compare changes

🚀 Enhancements

  • move logic of Static plugins to the top of module.ts to decrease the amount of code for SSG apps
  • improve rateLimiter with support for unstorage (#190)
  • remove console.logs after build (#128)
  • add an include option for basicAuth (#219)
  • option to disable hashing for SSG (#215)
  • support for CRSF in Serverless Environments

🩹 Fixes

  • useCsrf() is undefined (#203)
  • CSRF tokens cause breakage on build using serverless environments due to incompatible exports of Node Crypto (#167)
  • upgrade-insecure-requests cannot be turned off for static build (#214)
  • invalid permission policy parser (#194)
  • remove broken test for nonce (#213)

📖 Documentation

  • refactor docs to be easier (#135)
  • create faq section in docs from questions in Github issues (#192)
  • security composable to use in pages (#217)
  • Content-Security-Policy: The page’s settings blocked the loading of a resource at inline (#218)
  • custom CSP merger (#198)
  • stripe blocked by 'Cross-Origin-Embedder-Policy' (#229)
  • update 3.rate-limiter.md fix comma (#204)
  • New section for Contributing
  • New section for Usage
  • Reorganised Navigation
  • Added global Search
  • New Homepage
  • New section for Headers
  • New section for utils
  • Embedded Playground
  • New page for Releases
  • Migrated to newest docus
  • New Preview Image

🏡 Chore

  • remove legacy approach for middlewares in types and module.ts file (#191)
  • bump packages to newer versions (#183) -> Nuxt 3.2 -> 3.7
  • Reorganized project repository for easier maintenance
  • specify package manager (#225)
  • do not use default export for defu (#224)

🤖 CI

  • improved CI script for automatic unit tests for main, rc, and renovate branches

⚠️ Breaking Changes

  • Permissions Policy
  • Allowed Methods Restricter

❤️ Contributors

🏋️‍♂️ New Contributors

Contributors

Atinux, dargmuesli, and 12 other contributors
Assets 2
0 Join discussion

v0.14.4

05 Sep 07:30
@Baroshem Baroshem
v0.14.4
ea31a62
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.
Compare
Choose a tag to compare
v0.14.4

What's Changed

New Contributors

Full Changelog: v0.14.2...v0.14.4

Contributors

kouts, csprance, and Baroshem
Assets 2