# cert-expiry-check

> A module to check the expiry of HTTPS certificates

Latest version **0.2.0** (published 2016-05-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install cert-expiry-check
pnpm add cert-expiry-check
yarn add cert-expiry-check
bun add cert-expiry-check
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-05-31 |
| First published | 2016-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Joe Pettersson |
| Maintainers | joe8bit |

## Links

- npm: https://www.npmjs.com/package/cert-expiry-check
- npm.io page: https://npm.io/package/cert-expiry-check

## Recent versions

- 0.2.0 (latest) — 2016-05-31
- 0.1.0 — 2016-05-30

## README

## cert-expiry-check

[![CircleCI](https://circleci.com/gh/Joe8Bit/cert-expiry-check.svg?style=svg)](https://circleci.com/gh/Joe8Bit/cert-expiry-check)
[![npm version](https://badge.fury.io/js/cert-expiry-check.svg)](https://badge.fury.io/js/cert-expiry-check)

A module to check the expiry of SSL/TLS certs.

### Usage

In it's most basic form, using the default configuration:

```javascript
const CertExpiryCheck = require('cert-expiry-check');
const checker = new CertExpiryCheck();
checker.checkHosts([{
  hostname: 'www.google.com'
}]).then((results) => {
  console.log(results);
}).catch((e) => {
  console.error(e); // bubbles up HTTP errors and invalid cert chains
});
```

Gives the following result:

```json
[{
  "host":{
    "hostname":"www.google.com",
    "port":443,
    "alertWindowDays":30,
    "headers":{
      "User-Agent":"SSL Certificate Expiry Checker 0.1.0"
    },
    "method":"GET"
  },
  "details":{
    "subject":{
      "org":"Google Inc",
      "commonName":"www.google.com",
      "altName":"DNS:www.google.com"
    },
    "issuer":{
      "org":"Google Inc",
      "commonName":"Google Internet Authoritym G2"
    }
  },
  "validFrom":"2016-05-18T10:59:02.000Z",
  "validTo":"2016-08-10T10:46:00.000Z",
  "expiry":{
    "days":72,
    "milliseconds":6198331472,
    "isExpired":false,
    "isInAlertWindow":false
  }
}]
```

There are two types of configurations that can be performed, first the 'global' defaults used for all checked domains:

```javascript
const checker = new CertExpiryCheck({
  timeout: 5000, // timeout used for HTTPS connections
  defaultPort: 443, // port used for all HTTPS connections
  defaultAlertWindowDays: 30, // default alert window to use for near expiry certs
  userAgent: 'SSL Certificate Expiry Checker 0.1.0' // default user agent to send with requests
});
```

Secondly, the per host configurations that override the defaults (above) for each host to check:

```javascript
checker.checkHosts([{
  hostname: 'www.google.com',
  port: 443,
  alertWindowDays: 30,
  userAgent: 'SSL Certificate Expiry Checker 0.1.0'
}]).then((results) => {
  console.log(results);
})
```

**Note:** There is currently no support for self-signed certs, as this was outside of the core use-case. Happy to accept pull requests for support however.

### Development

```
git clone https://github.com/Joe8Bit/cert-expiry-check
cd cert-expiry-check
npm install -g ava nyc eslint babel-eslint && npm install
npm test
```

### Contributing

All contributors agree to abide by the `CODE_OF_CONDUCT.md`

### License

MIT

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