js-kit / auto-sni

Free, automated HTTPS for NodeJS made easy.

Auto SNI

SSL Certificates using SNI with almost zero configuration for free with https://letsencrypt.org! This module has yet to be thoroughly tested but feel free to give it a shot!

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: ["test.com", "(dev|staging|production).test.com"], // Optional list of allowed domains (uses pathtoregexp)
	forceSSL: true, // Make this false to disable auto http->https redirects (default true).
	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.createServer;

var app = createServer({ email: ..., agreeTos: 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

Rate Limits

Currently LetsEncrypt beta imposes some rate limits on certificate creation. These will likely increase over time. There are also talks of LetsEncrypt creating a form to increase the amount.

The current rates are:

• 10 new registrations every 3 hours.
• 5 certificates per domain every 7 days.

Contributions

Please feel free to create a PR!