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

signature-verifier-buzzfeed-sso

v0.1.1

Published

A signature verifier package for Buzzfeed's SSO

Downloads

14

Readme

SSO Signature Verifier for Buzzfeed SSO

Buzzfeed SSO is a simple easy-to-use Single Sign-On Proxy that can help protect web applications via a secured reverse proxy.

The sso_proxy component of Buzzfeed SSO allows signing of every request, so that you can determine whether the request entering your service has legitimately come from the sso_proxy.

This is a simple drop-in library which you can add to your NodeJS applications to verify the signature of the calling application.

Prerequisites

Certificate setup

Your sso_proxy needs to be configured to sign requests.

You can generate a certificate by running openssl genrsa 2048 | openssl pkcs8 -topk8 -inform pem -outform pem -nocrypt and copying the relevant output into a .pem file.

The sso_proxy application needs this certificate defined in an environment variable. An example shell script is below:

#!/bin/bash
export EMAIL_DOMAIN=yourdomain.com
export VIRTUAL_HOST=*.sso.yourdomain.com
# ... other config variables here...
export REQUEST_SIGNATURE_KEY=$(cat /path/to/cert.pem)

/path/to/sso-proxy

Once the proxy is up and running, you can grab the public key needed for this library by going to {sso_proxy_host}/oauth2/v1/certs. You'll want the part of the certificate that starts with -----BEGIN RSA PUBLIC KEY----- . Be sure to copy the whole thing and make sure you don't miss the newline character at the end!

Installation

npm install signature-verifier-buzzfeed-sso

Then in your code:

const SSOVerifier = require('signature-verifier-buzzfeed-sso');
const sso = new SSOVerifier(publicKeyString);   // Your Public key including the training newline

// Later on when you have headers, url and body
const isSignatureValid = sso.verifySignature(url, headers, body);
if (!isSignatureValid) {
    // Do whatever you need to
}

Examples

There are some examples in the examples directory which might help you get started.

Express

Check out this repository, then:

  • cd examples/express
  • npm install
  • Edit the config.js file and replace the base64encodedKey with a base64 encoded version of your public key
  • Run with npm run start
  • Configure an upstream server on your SSO proxy
  • Try accessing directly (ie not through the proxy) - see the failure
  • Try accessing through the proxy - see the success!