npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@httpland/csp-middleware

v1.0.0

Published

HTTP content security policy(CSP) middleware

Downloads

9

Readme

csp-middleware

deno land deno doc GitHub release (latest by date) codecov GitHub

test NPM

HTTP content security policy(CSP) middleware.

Compliant with Content Security Policy Level 3.

Middleware

For a definition of Universal HTTP middleware, see the http-middleware project.

Usage

Middleware adds the Content-Security-Policy header to the response.

import {
  csp,
  type Handler,
} from "https://deno.land/x/csp_middleware@$VERSION/mod.ts";
import { assert } from "https://deno.land/std/testing/asserts.ts";

declare const request: Request;
declare const handler: Handler;

const middleware = csp();
const response = await middleware(request, handler);

assert(response.headers.has("content-security-policy"));

yield:

Content-Security-Policy: default-src 'none'; script-src 'self'; connect-src 'self'; img-src 'self'; style-src 'self'; base-uri 'self'; form-action 'self'

The default header field value is compliant with Content Security Policy (CSP) Quick Reference Guide, Stater policy.

Options

Middleware factory takes following fields.

| Name | Type | Description | | ---------- | --------------- | -------------------------------------- | | directives | CSPDirectives | CSP directives. | | reportOnly | boolean | Whether the policy report only or not. |

Directives

directives can be one of the following.

  • CSPDirective
  • Camel casing CSPDirective

CSP directives

CSPDirectives are structured Content-Security-Policy header field objects.

Base types are as follows:

interface Directives {
  [k: string]: string | string[];
}

Each key represents a directive name and each value represents a directive value.

The Directive supports all directives in Content Security Policy Level 3.

Each directive may be restricted to a more strict type.

For example, a webrtc directive is restricted to 'allow' or 'block'.

import { csp } from "https://deno.land/x/csp_middleware@$VERSION/middleware.ts";

const middleware = csp({
  directives: {
    "default-src": "'none'",
    webrtc: "'allow'",
  },
});

Check deno doc for about CSPDirectives.

Camel casing

The directive name can also be defined in camel case. Overloading makes it exclusive.

import { csp } from "https://deno.land/x/csp_middleware@$VERSION/middleware.ts";

const middleware = csp({
  directives: {
    defaultSrc: "'none'",
    scriptSrc: ["'self'", "*.example.test"],
  },
});

Report Only

The header field changes depending on the value of reportOnly.

| Value | Header field | | ------- | ----------------------------------- | | true | Content-Security-Policy-Report-Only | | false | Content-Security-Policy |

The default reportOnly is false.

import {
  csp,
  type Handler,
} from "https://deno.land/x/csp_middleware@$VERSION/mod.ts";
import { assert } from "https://deno.land/std/testing/asserts.ts";

declare const request: Request;
declare const handler: Handler;

const middleware = csp({ reportOnly: true });
const response = await middleware(request, handler);

assert(response.headers.has("content-security-policy-report-only"));

Serialization error

CSP directives will serialize into string.

In Serialization, the directive name and directive value are validated based on ABNF. If they are invalid, an error may be thrown.

Errors are thrown in the following cases:

import { csp } from "https://deno.land/x/csp_middleware@$VERSION/middleware.ts";
import { assertThrows } from "https://deno.land/std/testing/asserts.ts";

assertThrows(() => csp({ directives: {} }));
assertThrows(() => csp({ directives: { defaultSrc: "<invalid>" } }));
assertThrows(() =>
  csp({ directives: { defaultSrc: ["<duplicate>", "<duplicate>"] } })
);

Effects

Middleware may make changes to the following elements of the HTTP message.

  • HTTP Headers
    • Content-Security-Policy
    • Content-Security-Policy-Report-Only

Conditions

Middleware will execute if all of the following conditions are met:

Depends on reportOnly:

  • Content-Security-Policy header does not exists in response
  • Content-Security-Policy-Report-Only header does not exists in response

API

All APIs can be found in the deno doc.

License

Copyright © 2023-present httpland.

Released under the MIT license