Need private packages and team management tools?Check out npm Teams »

dynamic-sni

1.6.0 • Public • Published

js-standard-style Join the chat at https://gitter.im/DylanPiercey/auto-sni

Dynamic SNI

It's a fork of auto-sni.

SSL Certificates using SNI with almost zero configuration for free with https://letsencrypt.org!

If you have any questions, throw them up on gitter.

Installation

Npm

npm install auto-sni

Features

  • Fetch SSL certificates from letsencrypt.
  • Automatically renew certificates.
  • If creating a certificate fails it will fall back to a simple self signed certificate.
  • Forward all incoming http requests to https.

Example

var createServer = require("auto-sni");
 
var server = createServer({
    email: ..., // Emailed when certificates expire.
    agreeTos: true, // Required for letsencrypt.
    debug: true, // Add console messages and uses staging LetsEncrypt server. (Disable in production)
    domains: ["mysite.com", ["test.com", "www.test.com"]], // List of accepted domain names. (You can use nested arrays to register bundles with LE).
    forceSSL: true, // Make this false to disable auto http->https redirects (default true).
    redirectCode: 301, // If forceSSL is true, decide if redirect should be 301 (permanent) or 302 (temporary). Defaults to 302
    ports: {
        http: 80, // Optionally override the default http port.
        https: 443 // // Optionally override the default https port.
    }
});
 
// Server is a "https.createServer" instance.
server.once("listening", ()=> {
    console.log("We are ready to go.");
});
 

Usage with express.

var createServer = require("auto-sni");
var express      = require("express");
var app          = express();
 
app.get("/test", ...);
 
createServer({ email: ..., agreeTos: true }, app);

Usage with koa.

var createServer = require("auto-sni");
var koa          = require("koa");
var app          = koa();
 
app.use(...);
 
createServer({ email: ..., agreeTos: true }, app.callback());

Usage with rill.

var createServer = require("auto-sni");
var rill         = require("rill");
var app          = rill();
 
app.get("/test", ...);
 
createServer({ email: ..., agreeTos: true }, app.handler());

Usage with hapi.

// Untested (Let me know in gitter if this doesn't work.)
var createServer = require("auto-sni");
var hapi         = require("hapi");
var server       = new hapi.Server();
var secureServer = createServer({ email: ..., agreeTos: true });
 
server.connection({ listener: secureServer, autoListen: false, tls: true });

Usage with restify.

// Untested (Let me know in gitter if this doesn't work.)
var createServer = require("auto-sni");
var restify      = require("restify");
 
// Override the https module in AutoSNI with restify.
createServer.https = restify;
 
// Use a special restify option.
var app = createServer({ email: ..., agreeTos: true, restify: true });
app.get("/test", ...);

Root Access

AutoSNI requires access to low level ports 80 (http) and 443 (https) to operate by default. These ports are typically restricted by the operating system.

In production (on linux servers) you can use the following command to give Node access to these ports.

sudo setcap cap_net_bind_service=+ep $(which node)

For development it's best to set the "ports" option manually to something like:

{
    ports: {
        http: 3001,
        https: 3002
    }
}
 
// Access server on localhost:3002

Location of certificates

For production you may wish to start backing up or distributing the certificates across multiple sersers. Auto-SNI stores the certificates under the ~/letsencrypt folder. During development you may find you need to refresh/reset these cerificates, in which case you can simply remove the directory.

Rate Limits

Currently LetsEncrypt imposes some rate limits on certificate creation. Click here for the current rate limits.

Contributions

Please use npm test for tests and feel free to create a PR!

Install

npm i dynamic-sni

DownloadsWeekly Downloads

0

Version

1.6.0

License

MIT

Last publish

Collaborators

  • avatar