Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/louisbrulenaudet/open-sri

Ultralight, non-dependent and minimalist open-source package to recursively generate subresource integrity (SRI) hashes.
https://github.com/louisbrulenaudet/open-sri

javascript nodejs npm-package sri

Last synced: 29 days ago
JSON representation

Ultralight, non-dependent and minimalist open-source package to recursively generate subresource integrity (SRI) hashes.

Host: GitHub
URL: https://github.com/louisbrulenaudet/open-sri
Owner: louisbrulenaudet
License: mit
Created: 2022-08-27T10:29:51.000Z (over 2 years ago)
Default Branch: main
Last Pushed: 2023-05-09T09:53:10.000Z (over 1 year ago)
Last Synced: 2024-10-12T23:30:10.594Z (2 months ago)
Topics: javascript, nodejs, npm-package, sri
Language: JavaScript
Homepage: https://www.npmjs.com/package/open-sri
Size: 23.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # open-sri



Ultralight, non-dependent and minimalist open-source package to recursively generate **sha-256**, **sha-384** or **sha-512** subresource integrity hashes to authenticate **.js** and **.css** files.

```js

const sri = require("open-sri");

sri.get("./public/css", "sha384");

```

[Subresource Integrity](https://developer.mozilla.org/fr/docs/Web/Security/Subresource_Integrity) or SRI is a [W3C recommendation](https://www.w3.org/TR/SRI/) to provide a method to protect website delivery from CDN-served malicious code.

To use SRI, a website author wishing to include a static resource can specify a cryptographic hash of the resource in addition to the location of the resource. Browsers fetching the resource can then compare the hash provided by the website author with the hash computed from the resource. If the hashes don't match, the resource is discarded.

```html

```

This package aims at automating the process of generating cryptographic hashes in order to facilitate their access, by parsing directories and subdirectories to extract static files.

[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/) 

[![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/louisbrulenaudet/open-sri/issues)

![npm version](https://img.shields.io/npm/v/open-sri)

## Features

- Low memory usage

- Executable for generating applications quickly

- High availability for synchronization with CDN systems

- Simple deployment with one-line integration

## Tech Stack

**Server:** Node, Express

## Installation

This is a [Node.js](https://nodejs.org/en/) module available through the [npm](https://www.npmjs.com/) & [yarn](https://yarnpkg.com/?q=open-sri) registries.

Before installing, [download and install Node.js](https://nodejs.org/en/download/). Node.js 0.10 or higher is required.

If this is a brand new project, make sure to create a `package.json` first with the [`npm init` command](https://docs.npmjs.com/creating-a-package-json-file). Then:

```bash

  npm i open-sri 

  yarn install open-sri

```

## Importing

```js

// Using Node.js 'require()'

const sri = require('open-sri');

```

## Documentation

The `get` function take two arguments, the `directory` (`string`) containing static files we want to obtain hashes from, and the required `algorithm` for the calculation `sha256`, `sha384` or `sha512` (`string`). 

Return `JSON` object.

## Usage/Examples

```javascript

const sri = require("open-sri");

sri.get("./public/css", "sha384");

```

```javascript

[

  {

    filepath: 'public/css/index.css',

    hash: 'sha384-yTRuc6ItZNScTYLXkpwURSAsaZLKgfoWi69Nku5bK2/1HW2O8OOgcli2jdgvIJnE'

  }

]

```

Then, we can observe the creation of a JSON element, containing each filepath contained in the directory and its subdirectories, as well as the assignment of a unique hash preceded by the mention `"sha256-"`, `"sha384-"` or `"sha512-"` directly exploitable in your routes configuration file.

## License

Copyright (c) 2022 Louis Brulé Naudet .

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.

## Feedback

If you have any feedback, please reach out to us at [email protected].