Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

le-challenge-sni

insightfuls1.3k(MIT OR Apache-2.0)2.0.1

A strategy for node-letsencrypt for setting, retrieving, and clearing ACME challenges by registering self-signed certs with the SNI handler.

le-challenge, le-challenge-, sni, tls-sni-01, tls-sni-02, ACME, letsencrypt, certbot

readme

le-challenge-sni

A strategy for node-letsencrypt for setting, retrieving, and clearing ACME challenges by registering self-signed certs with the SNI handler.

It is designed to handle tls-sni-01 and tls-sni-02 challenges.

Install

npm install --save le-challenge-sni@2.x

Usage

var leChallenge = require('le-challenge-sni').create({
  debug: false
});

var LE = require('letsencrypt');

LE.create({
  server: LE.stagingServerUrl
, challenge: leChallenge
});

le-challenge-sni requires the sni option to letsencrypt to have cacheCerts and uncacheCerts methods. These are used to register/unregister the certificates. The default le-sni-auto instance satisfies this requirement.

It also requires the challengeType option to letsencrypt to be either tls-sni-01 or tls-sni-02 and will generate and register certificates accordingly.

Exposed Methods

For ACME Challenge:

  • set(opts, domain, key, val, done)
  • get(defaults, domain, key, done)
  • remove(defaults, domain, key, done)

For node-letsencrypt internals:

  • getOptions() returns the user supplied options, if any (no effect)