greenlock-express.js

(formerly letsencrypt-express.js)

| greenlock (lib) | greenlock-cli | greenlock-express | greenlock-cluster | greenlock-koa | greenlock-hapi |

| Sponsored by ppl

Free SSL and managed or automatic HTTPS for node.js with Express, Koa, Connect, Hapi, and all other middleware systems.

• Automatic Registration via SNI (httpsOptions.SNICallback)
  • registrations require an approval callback in production
• Automatic Renewal (around 80 days)
  • renewals are fully automatic and happen in the background, with no downtime
• Automatic vhost / virtual hosting

All you have to do is start the webserver and then visit it at its domain name.

Now supports Let's Encrypt v2!!

• Let's Encrypt v1 (aka v01)
• Let's Encrypt v2 (aka v02 or ACME draft 11)
• ACME draft 11 (ACME v2 is a misnomer)
• Wildcard domains!! (via dns-01 challenges)
  • *.example.com

Install

npm install --save greenlock-express@2.x

Important: Use node v4.5+ or v6.x, node <= v4.4 has a known bug in the Buffer implementation.

QuickStart

Here's a completely working example that will get you started:

app.js:

'use strict';

require('greenlock-express').create({

  // Let's Encrypt v2 is ACME draft 11
  version: 'draft-11'

  // You MUST change 'acme-staging-v02' to 'acme-v02' in production
, server: 'https://acme-staging-v02.api.letsencrypt.org/directory'  // staging

  // You MUST change this to a valid email address
, email: 'john.doe@example.com'

  // You MUST NOT build clients that accept the ToS without asking the user
, agreeTos: true

  // You MUST change these to valid domains
  // NOTE: all domains will validated and listed on the certificate
, approveDomains: [ 'example.com', 'www.example.com' ]

  // You MUST have access to write to directory where certs are saved
  // ex: /home/foouser/acme/etc
, configDir: require('path').join(require('os').homedir(), 'acme', 'etc')

, app: require('express')().use('/', function (req, res) {
    res.setHeader('Content-Type', 'text/html; charset=utf-8')
    res.end('Hello, World!\n\n💚 🔒.js');
  })

//, debug: true

}).listen(80, 443);

What if the example didn't work?

First and foremost:

• You MUST run this on the public-facing webserver, as the webserver

Exception: using 'dns-01' (i.e. le-challenge-route53) you can validate domains set to private addresses (10.x, 192.168.x, etc).

Double check each of the following:

• Let's Encrypt v2 uses version: 'draft-11', but v1 uses version: 'v01'
• You MUST set email to a valid address with valid MX records (dig MX example.com for 'john@example.com')
• You MUST set approveDomains to domains with valid DNS records (test with dig +trace A example.com; dig +trace www.example.com for [ 'example.com', 'www.example.com' ])
• You MUST have write access to configDir so that certs can be saved (test with touch ~/acme/etc/tmp.tmp)
• You MUST have bind privileges to ports 80 and 44 via sudo or setcap

If you get a red lock instead of a green lock:

• You MUST change the server value in production. Just shorten the 'acme-staging-v02' part to 'acme-v02'

Get it working in staging first!

• You MUST NOT exceed the API usage limits per domain, certificate, IP address, etc

There are a number of common problems related to system configuration - firewalls, ports, permissions, etc - that you are likely to run up against when using greenlock for your first time.

In order to avoid being blocked by hitting rate limits with bad requests, you should always test against the staging server (https://acme-staging-v02.api.letsencrypt.org/directory) first.

Usage

The oversimplified example was the bait (because everyone seems to want an example that fits in 3 lines, even if it's terribly bad practices), now here's the switch:

serve.js:

'use strict';

// returns an instance of greenlock.js with additional helper methods
var lex = require('greenlock-express').create({
  // set to https://acme-v02.api.letsencrypt.org/directory in production
  server: 'https://acme-staging-v02.api.letsencrypt.org/directory'
, version: 'draft-11' // Let's Encrypt v2 (ACME v2)

// If you wish to replace the default plugins, you may do so here
//
, challenges: { 'http-01': require('le-challenge-fs').create({ webrootPath: '/tmp/acme-challenges' }) }
, store: require('le-store-certbot').create({ webrootPath: '/tmp/acme-challenges' })

// You probably wouldn't need to replace the default sni handler
// See https://git.coolaj86.com/coolaj86/le-sni-auto if you think you do
//, sni: require('le-sni-auto').create({})

, approveDomains: approveDomains
});

function approveDomains(opts, certs, cb) {
  // This is where you check your database and associated
  // email addresses with domains and agreements and such


  // The domains being approved for the first time are listed in opts.domains
  // Certs being renewed are listed in certs.altnames
  if (certs) {
    opts.domains = certs.altnames;
  }
  else {
    opts.email = 'john.doe@example.com';
    opts.agreeTos = true;
  }

  // NOTE: you can also change other options such as `challengeType` and `challenge`
  // opts.challengeType = 'http-01';
  // opts.challenge = require('le-challenge-fs').create({});

  cb(null, { options: opts, certs: certs });
}

// handles acme-challenge and redirects to https
require('http').createServer(lex.middleware(require('redirect-https')())).listen(80, function () {
  console.log("Listening for ACME http-01 challenges on", this.address());
});



var app = require('express')();
app.use('/', function (req, res) {
  res.end('Hello, World!');
});

// handles your app
require('https').createServer(lex.httpsOptions, lex.middleware(app)).listen(443, function () {
  console.log("Listening for ACME tls-sni-01 challenges and serve app on", this.address());
});

Security Warning:

If you don't do proper checks in approveDomains(opts, certs, cb) an attacker will spoof SNI packets with bad hostnames and that will cause you to be rate-limited and or blocked from the ACME server.

API

This module is an elaborate ruse (to provide an oversimplified example and to nab some SEO).

The API is actually located at greenlock.js options (because all options are simply passed through to greenlock.js proper without modification).

The only "API" consists of two options, the rest is just a wrapper around greenlock.js to take LOC from 15 to 5:

• opts.app An express app in the format function (req, res) { ... } (no next).
• lex.listen(plainPort, tlsPort) Accepts port numbers (or arrays of port numbers) to listen on.

Brief overview of some simple options for greenlock.js:

• opts.server set to https://acme-v02.api.letsencrypt.org/directory in production
• opts.version set to v01 for Let's Encrypt v1 or draft-11 for Let's Encrypt v2 (mistakenly called ACME v2)
• opts.email The default email to use to accept agreements.
• opts.agreeTos When set to true, this always accepts the LetsEncrypt TOS. When a string it checks the agreement url first.
• opts.approveDomains can be either of:
  • An explicit array of allowed domains such as [ 'example.com', 'www.example.com' ]
  • A callback function (opts, certs, cb) { cb(null, { options: opts, certs: certs }); } for setting email, agreeTos, domains, etc (as shown in usage example above)
• opts.renewWithin is the maximum number of days (in ms) before expiration to renew a certificate.
• opts.renewBy is the minimum number of days (in ms) before expiration to renew a certificate.