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

s3layer

v0.7.1

Published

Node.js middleware for controlled proxying Amazon S3 objects to Internet

Downloads

5

Readme

Express/Connect middleware for proxying files from S3 to Internet

With this middleware you can:

  • check authorization of a user to access a target object(using ACL, RBAC, etc.)
  • translate urls to S3 keys

This middleware supports:

  • Caching objects
  • Piping objects from S3 to response, so objects don't fully loaded in memory

Install

npm install s3layer

Usage example:

var
  app = require("express")(),
  S3Layer = require("s3layer");

AWS_SETUP = {
  accessKeyId: "...",
  secretAccessKey: "...",
  bucket: "..." // default bucket
};

// create a middleware
var s3l = S3Layer({
  AWS: AWS_SETUP,
  // the default bucket, can be overwritten by a getS3Key's returned value
  bucket: AWS_SETUP.bucket,
  /**
  * params has fields:
  * req - http request
  * res - http response
  * url - requested url
  */
  getS3Key: function(params, cb) {
    params.url = params.url.replace(/^\//, "");
    if(params.url == "restricted-file.png") {
      params.res.status(403).send("Forbidden");
      return;
    }
    // proxy request to Key = params.url
    cb(null, params.url);
  }
});

// use the middleware in the express application
app.use("/files", s3l);

getS3Key

Accepts a request params and a callback function, in the callback function you can return:

  • string - interpreted as S3 Key
  • object which can contain key and bucket fields

For example:

  getS3Key: function(params, cb) {
    params.url = params.url.replace(/^\//, "");
    if(params.url == "restricted-file.png") {
      params.res.status(403).send("Forbidden");
      return;
    }
    // proxy request to Key = params.url
    cb(null, {
      key: params.url,
      bucket: "another-bucket"
    });
  }

modifyHeaders

You can modify headers returned for a file, with modifyHeaders callback:

For example

  /**
   * @param  {Object} params
   * @return {Object} params.headers - headers returned by Amazon S3
   * @return {Object} params.outHeaders - headers that will be returned in a HTTP response, you can modify them directly
   */
  modifyHeaders: function(params) {
    if(params.headers["content-type"] && params.headers["content-type"].indexOf("image/") === 0) {
      // force download all images
      params.outHeaders["Content-Disposition"] = 'attachment; filename="img.jpg"';
    }
  }

modifyHeaders is synchronous!