Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/JonasKruckenberg/rollup-plugin-sri
Add subresource integrity tags to all your html files 🔒
https://github.com/JonasKruckenberg/rollup-plugin-sri
integrity rollup-plugin rollup-plugin-rsi security subresource-integrity
Last synced: 25 days ago
JSON representation
Add subresource integrity tags to all your html files 🔒
- Host: GitHub
- URL: https://github.com/JonasKruckenberg/rollup-plugin-sri
- Owner: JonasKruckenberg
- License: mit
- Created: 2020-05-19T21:44:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-09T03:49:46.000Z (almost 2 years ago)
- Last Synced: 2024-10-30T03:55:39.542Z (about 1 month ago)
- Topics: integrity, rollup-plugin, rollup-plugin-rsi, security, subresource-integrity
- Language: TypeScript
- Homepage:
- Size: 1.05 MB
- Stars: 24
- Watchers: 3
- Forks: 4
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome - sri - Add subresource integrity attributes for your bundle. (Plugins / Output)
README
> ## **NOTE**: ‼️ This project will be archived in **2 Weeks**!
>
> If you're interested in why or potentially continue maintaining this repo [read here](https://github.com/JonasKruckenberg/rollup-plugin-sri/issues/393)
# rollup-plugin-sri
> Because web security should not be difficult.
[](https://codecov.io/gh/JonasKruckenberg/rollup-plugin-sri/)
[](https://github.com/RichardLitt/standard-readme)
This plugin adds [subresource integrity](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity) attributes to all resources imported by your html files.
## Table of Contents
- [Install](#install)
- [Usage](#usage)
- [Simple](#simple)
- [External resources](#external-resources)
- [Multiple hashing algorithms](#multiple-hashing-algorithms)
- [Usage with Vite](#usage-with-vite)
- [Options](#options)
- [Contributing](#contributing)
- [License](#license)
## Install
via npm:
```
npm install --save-dev rollup-plugin-sri
```
or via yarn:
```
yarn add -D rollup-plugin-sri
```
## Usage
Just use this plugin together with another plugin that outputs an html file, like [@rollup/plugin-html](https://github.com/rollup/plugins/tree/master/packages/html).
It will then generate `integrity` and `crossorigin` attributes for all script tags and all link rel="stylesheet" tags.
```js
import html from '@rollup/plugin-html' // or any other html-plugin
import sri from 'rollup-plugin-sri'
export default {
input: 'index.js',
output: {
file: 'out.js',
format: 'es'
},
plugins: [html(), sri()]
}
```
## Examples
### Simple
You might have a script tag in your html to include a javascript file like this:
```html
```
Which then gets turned into this:
```html
```
### External resources
Let's say you're using Bootstrap on your page, but it get dynamically injected so you can't set the integrity attribute yourself.
The html will then look something like this:
```html
```
This plugin will turn it into the following:
```html
```
### Multiple hashing algorithms
You can also specify any number of hashing algorithms to be used by the plugin as long as they are supported by your current version of nodejs.
```js
import html from '@rollup/plugin-html' // @rollup/plugin-html for example
import sri from 'rollup-plugin-sri'
export default {
input: 'index.js',
output: {
file: 'out.js',
format: 'es'
},
plugins: [
html(),
sri({
algorithms: ['sha1', 'md5', 'sha512']
})
]
}
```
This config will generate an output like this:
```html
```
> There are a few things to note though:
>
> 1. You can in theory use any hashing algorithm you want, however most browser only support the sha family of hashing algorithms like sha256, sha384 and sha512
> 2. Browser vendors are actively discouraged from using `md5` and `sha1` as they are not considered to be secure enough.
> Most modern browser won't accept them at all.
### Usage with Vite
To use this plugin together with [vite](https://vitejs.dev) use the configuration below.
```js
import { defineConfig } from "vite"
import sri from "rollup-plugin-sri"
export default defineConfig({
plugins: [
{
enforce: "post",
...sri({ publicPath: "/" })
}
]
})
```
> NOTE: Becuase of the way vite works, this plugin only applies SRIs when building for production. To get the same experience in development mode, check out [vite-plugin-sri](https://github.com/small-tech/vite-plugin-sri)!
## Options
> For the most up-to-date version of the options see the autogenerated [docs](./docs/README.md).
### `Optional` active
Type: _boolean_
**`default`** `true`
Can be used to disable the plugin, as subresource integrities might cause issues with hot module reloading.
---
### `Optional` algorithms
Type: _Array[*string* \| *sha256* \| *sha384* \| *sha512*]_
**`default`** `["sha384"]`
A list of hashing algorithms to use when computing the integrity attribute.
The hashing algorithm has to be supported by the nodejs version you're running on and by the Browser you're targeting.
Browsers will ignore unknown hashing functions.
Standard hash functions as defined in the [subresource integrity specification](https://w3c.github.io/webappsec-subresource-integrity/#hash-functions) are: `sha256`, `sha384` and `sha512`.
> NOTE: While browser vendors are free to support more algorithms than those stated above,
> they generally do not accept `sha1` and `md5` hashes.
---
### `Optional` crossorigin
Type: _"anonymous" | "use-credentials"_
**`default`** `"anonymous"`
Specifies the value for the crossorigin attribute.
This attribute has to be set to prevent cross-origin data leakage.
The default value `anonymous` should be okay for normal use.
see: [the W3C spec](https://www.w3.org/TR/SRI/#cross-origin-data-leakage) for details.
---
### `Optional` selectors
Type: _Array[string]_
**`default`** ` ["script","link[rel=stylesheet]"]`
A list of strings you can provide that the plugin will use to match html tags with.
It will then try to compute an integrity attribute for the matched tag.
Currently it only matches script tags and link with rel=stylesheet as per specification.
see [the W3C spec](https://www.w3.org/TR/SRI/#elements) for more information.
The selector syntax is the same as jQuery's.
### `Optional` publicPath
Type: _string_
**`default`** `""`
Commonly assets will be prefixed with a public path, such as "/" or "/assets".
Setting this option to the public path allows plugin-sri to resolve those imports.
## Contributing
For bug reports or feature requests please create an issue on github.
When working on a feature contribution, please ensure the following things:
- Keep you code clear and readable.
- Write unit tests for your feature (run `yarn test`).
- Use the convetional-commits style when writing commit messages.
- Use appropriate commit types, When adding tests use `test:` when adding a feature use `feat:` etc.
- Split up the files you commit logically not by workday or something else, for example all test belonging to a new feature should be in their own commit and not bunched together with other changes or tests for other features.
## Sponsoring
Are you using imagetools in your company, in a commercial project or just feeling generous?
Consider [sponsoring me on GitHub](https://github.com/sponsors/JonasKruckenberg) to support the development and get your companies logo featured!
## License
[MIT © Jonas Kruckenberg.](LICENSE)