@ampproject/toolbox-script-csp

v2.9.0

A library that calculates the CSP hash for amp-script

NPM

README

GitHub

Apache-2.0

Latest version published 4 days ago

    npm install @ampproject/toolbox-script-csp

Explore Similar Packages

Package Health Score

92 / 100

Security
No known security issues
Popularity
Popular
Maintenance
Healthy
Community
Active

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Secure Your Project

Find & fix vulnerable dependencies and insecure code

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version				Vulnerabilities	License Risk
2.9.0	\|	06/2022		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.8.0	\|	05/2021		0 C 0 H 0 M 0 L	0 H 0 M 0 L
2.5.4	\|	06/2020	Popular	0 C 0 H 0 M 0 L	0 H 0 M 0 L
1.1.1	\|	10/2019		0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

Apache-2.0

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

# Install the Snyk CLI and test your project 
 npm i snyk -g && snyk test @ampproject/toolbox-script-csp

Get started free

Popularity

Popular

Weekly Downloads (152,073)

Dependents: 10
GitHub Stars: 426
Forks: 241
Contributors: 60

Direct Usage Popularity

The npm package @ampproject/toolbox-script-csp receives a total of 152,073 downloads a week. As such, we scored @ampproject/toolbox-script-csp popularity level to be Popular.

Based on project statistics from the GitHub repository for the npm package @ampproject/toolbox-script-csp, we found that it has been starred 426 times, and that 10 other projects in the ecosystem are dependent on it.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: Yes
Contributors: 60
Funding: No

With more than 10 contributors for the @ampproject/toolbox-script-csp repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 83
Open PR: 4
Last Release: 4 days ago
Last Commit: 4 days ago

Further analysis of the maintenance status of @ampproject/toolbox-script-csp based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that @ampproject/toolbox-script-csp demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Package

Node.js Compatibility: not defined

Age: 3 years
Dependencies: 0 Direct
Versions: 14
Install Size: 16.8 kB
Dist-tags: 3
# of Files: 5
Maintainers: 16
TS Typings: No

@ampproject/toolbox-script-csp has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

AMP-Toolbox Script CSP

Calculates the Content Security Policy (CSP) hash for the given script in the format expected by amp-script.

CSP is required when using amp-script with inline or cross-origin scripts.

Usage

Install via:

$ npm install @ampproject/toolbox-script-csp

Using the module

The module exposes a single function, calculateHash(src, options?).

src can be either a string (in which case UTF8 encoding is assumed) or a DataView such as a Buffer.

options is used to override the default options.

Options

algorithm overrides the hashing algorithm to use. Currently, the only algorithm supported by amp-script is sha384 which is the default value.

Example

Here is an example on how to use the calculateHash function to generate an amp-script CSP header.

Note that both leading and trailing whitespace is included in calculating the hash and must exactly match the whitespace used in the inline script.

const {calculateHash} = require('@ampproject/toolbox-script-csp');

const script = `
    const subject = 'world';
    console.log('Hello, ' + subject);
    `;

const hash = calculateHash(script);

console.log(hash);  // sha384-xRxb5sv13at6tVgZET4JLmf89TSZP10HjCGXVqO9bKWVXB0asV2jLrsDN8v4zX6j

The generated hash can be used in a <meta> tag this way:

<!doctype html>
<html ⚡>
<head>
  ...

  <meta name="amp-script-src" content="sha384-xRxb5sv13at6tVgZET4JLmf89TSZP10HjCGXVqO9bKWVXB0asV2jLrsDN8v4zX6j">
</head>
  <body>
    ...

    <amp-script layout="container" script="example"></amp-script>

    <script id="example" type="text/plain" target="amp-script">
    const subject = 'world';
    console.log('Hello, ' + subject);
    </script>
  </body>
</html>

FAQs

What is @ampproject/toolbox-script-csp?

A library that calculates the CSP hash for amp-script. Visit Snyk Advisor to see a full health score report for @ampproject/toolbox-script-csp, including popularity, security, maintenance & community analysis.

Is @ampproject/toolbox-script-csp popular?

The npm package @ampproject/toolbox-script-csp receives a total of 152,073 weekly downloads. As such, @ampproject/toolbox-script-csp popularity was classified as a popular. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is @ampproject/toolbox-script-csp well maintained?

We found that @ampproject/toolbox-script-csp demonstrated a healthy version release cadence and project activity. It has a community of 60 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is @ampproject/toolbox-script-csp safe to use?

The npm package @ampproject/toolbox-script-csp was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 26 June-2022, at 08:15 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP