# le-challenge-sni

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

Latest version **2.0.1** (published 2016-10-08) · (MIT OR Apache-2.0) license · 0 weekly downloads

## Install

```sh
npm install le-challenge-sni
pnpm add le-challenge-sni
yarn add le-challenge-sni
bun add le-challenge-sni
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2016-10-08 |
| First published | 2016-10-08 |
| Weekly downloads | 0 |
| License | (MIT OR Apache-2.0) |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Ben Schmidt |
| Maintainers | insightfuls |
| Keywords | le-challenge, le-challenge-, sni, tls-sni-01, tls-sni-02, ACME, letsencrypt, certbot |

## Links

- npm: https://www.npmjs.com/package/le-challenge-sni
- Repository: https://github.com/insightfuls/le-challenge-sni
- Homepage: https://github.com/insightfuls/le-challenge-sni#readme
- Issues: https://github.com/insightfuls/le-challenge-sni/issues
- npm.io page: https://npm.io/package/le-challenge-sni

## Dependencies (1)

- [le-tls-sni](https://npm.io/package/le-tls-sni.md) ^0.1.0

## Recent versions

- 2.0.1 (latest) — 2016-10-08
- 2.0.0 — 2016-10-08

## 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
-------

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

Usage
-----

```javascript
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)

---
_Source: https://npm.io/package/le-challenge-sni · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._