@denis-kalinin/dev-certs/README.md

Managing certificates on nodejs http server

# dev-certs

This is a refactored [Office-Addin-dev-certs](https://github.com/OfficeDev/Office-Addin-Scripts/tree/master/packages/office-addin-dev-certs).
This package can be used to manage certificates for nodejs development server using any hostname.

The goal of the refactoring is to extend [API](#api-usage), adding hostnames parameter to `getHttpsServerOptions` method.

## Installation

```
npm install @denis-kalinin/dev-certs
```

Upon installation a development CA certicate and localhost key and
certificate will be generated inside `<userhome>/.office-addin-dev-certs`. 
The certificate is valid for 30 days by default.

#

## Command-Line Interface
* [install](#install)
* [verify](#verify)
* [uninstall](#uninstall)

#

### install
Creates an SSL certificate for "localhost" signed by a developer CA certificate and installs the developer CA certificate so that the certificates are trusted. If the certificates were installed but are no longer valid, they will be replaced with valid certificates.

Syntax:

`office-addin-dev-certs install [options]`

Options:

`--machine`

Install the CA certificate for all users. You must be an Administrator.

`--days <days>`

Specifies the number of days until the CA certificate expires. Default: 30 days.
 
#

### verify
Verify the certificate.

Syntax:

`office-addin-dev-certs verify`
 
#

### uninstall
Uninstall the certificate.

Syntax:

`office-addin-dev-certs uninstall [options]`

Options:

`--machine`

Uninstall the CA certificate for all users. You must be an Administrator.

#

## API Usage

```js
var https = require('https')
var devCerts = require("@denis-kalinin/dev-certs");
var options =  await devCerts.getHttpsServerOptions({
  cert:{
    domains: ['my.localtest.me', 'localhost'], //certificate's alter names
    fileName: 'localtest' //creates files localtest.crt and localtest.key, useful when using dev-certs in many projects
  },
  ca: {
    validityDays: 90
  }
});

var server = https.createServer(options, function (req, res) {
  res.end('This is servered over HTTPS')
})

server.listen(443, function () {
  console.log('The server is running on https://localhost:443')
})
```