@ampproject/toolbox-script-csp

v2.5.4

A library that calculates the CSP hash for amp-script

NPM

README

GitHub

Website

Apache-2.0

Latest version published 10 months ago

    npm install @ampproject/toolbox-script-csp

We couldn't find any similar packages Browse all packages

Package Health Score

92 / 100

Popularity
Popular
Maintenance
Healthy
Security
No known security issues
Community
Active

Make sure the open source you're using is safe to use

Secure my Project

Popularity

Popular

Weekly Downloads (692,039)

Dependents: 10
GitHub Stars: 372
Forks: 215
Contributors: 60

The npm package @ampproject/toolbox-script-csp receives a total of 692,039 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 372 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.

Security

No known security issues

Security and license risk for significant versions

All Versions

Direct Vulnerabilities

1.1.1

2.3.0

2.5.4

Indirect Vulnerabilities

1.1.1

2.3.0

2.5.4

License Risks

1.1.1

2.3.0

2.5.4

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

License

Apache-2.0

Security Policy

We found a way for you to contribute to the project! Looks like @ampproject/toolbox-script-csp is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

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

Keep your project free of vulnerabilities with Snyk

Maintenance

Healthy

Commit Frequency

Open Issues: 71
Open PR: 4
Last Release: 10 months ago
Last Commit: 2 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 12 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.

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

Package

Node.js Compatibility: not defined

Age: 2 years
Dependencies: 0 Direct
Versions: 12
Install Size: 16.8 kB
Dist-tags: 3
# of Files: 5
Maintainers: 13
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.

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>