@jsenv/https-localhost v1.0.0

Https localhost

Generate https certificate to use for a server running on localhost.

Presentation

@jsenv/https-localhost generates what is needed to start a local server in https:

• a certificate
• a private key

import { requestCertificateForLocalhost } from "@jsenv/https-localhost"

const { serverCertificate, serverPrivateKey } = await requestCertificateForLocalhost({
  serverCertificateFileUrl: new URL("./certificates/server.crt", import.meta.url),
})

Trusting certificate

Every time requestCertificateForLocalhost is executed it checks if the root certificate is trusted. When not, a log explains how to trust it on your OS.

Message when certificate is not trusted on macOS

Root certificate must be added to macOS keychain
--- root certificate file ---
/Users/dmail/Library/Application Support/jsenv_https_localhost/jsenv_root_certificate.crt
--- suggested documentation ---
https://support.apple.com/guide/keychain-access/add-certificates-to-a-keychain-kyca2431/mac
--- suggested command ---
sudo security add-trusted-cert -d -r trustRoot -k /Library/Keychains/System.keychain -p ssl -p basic "/Users/dmail/Library/Application Support/jsenv_https_localhost/jsenv_root_certificate.crt"

It is possible to automate the trusting of the root certificate using tryToTrustRootCertificate.

import { requestCertificateForLocalhost } from "@jsenv/https-localhost"

const { serverCertificate, serverPrivateKey } = await requestCertificateForLocalhost({
  serverCertificateFileUrl: new URL("./certificates/server.crt", import.meta.url),
  tryToTrustRootCertificate: true,
})

Mapping hosts

Every time requestCertificateForLocalhost is executed it checks if server hostnames are properly mapped to 127.0.0.1 in your hosts file.

Message when hostnames are not mapped on macOS

2 hostnames(s) must be mapped to 127.0.0.1
--- hostnames ---
localhost
*.localhost
--- hosts file ---
/etc/hosts
--- suggested hosts file content ---
127.0.0.1 localhost
127.0.0.1 *.localhost

It is possible to automate the update of hosts file using tryToRegisterHostnames.

import { requestCertificateForLocalhost } from "@jsenv/https-localhost"

const { serverCertificate, serverPrivateKey } = await requestCertificateForLocalhost({
  serverCertificateFileUrl: new URL("./certificates/server.crt", import.meta.url),
  tryToRegisterHostnames: true,
})

On windows tryToRegisterHostnames is ignored, you have to do it manually for now.

Add more alternative names

When you need to make certificate works for other hosts than localhost use serverCertificateAltNames.

import { requestCertificateForLocalhost } from "@jsenv/https-localhost"

const { serverCertificate, serverPrivateKey } = await requestCertificateForLocalhost({
  serverCertificateFileUrl: new URL("./certificates/server.crt", import.meta.url),
  serverCertificateAltNames: ["whatever"], // makes certificate also valid for https://whatever
})

All host passed in serverCertificateAltNames must be mapped to 127.0.0.1 in your hosts file. This is done for you when tryToRegisterHostnames is enabled.

Usage with node server

import { createServer } from "node:https"
import { requestCertificateForLocalhost } from "@jsenv/https-localhost"

const { serverCertificate, serverPrivateKey } = await requestCertificateForLocalhost({
  serverCertificateFileUrl: new URL("./certificates/server.crt", import.meta.url),
  tryToTrustRootCertificate: true,
  tryToRegisterHostnames: true,
})

const server = createServer(
  {
    cert: serverCertificate,
    key: serverPrivateKey,
  },
  (request, response) => {
    const body = "Hello world"
    response.writeHead(200, {
      "content-type": "text/plain",
      "content-length": Buffer.byteLength(body),
    })
    response.write(body)
    response.end()
  },
)
server.listen(8080)

console.log(`Server listening at https://localhost:8080`)

Installation

npm install --save-dev @jsenv/https-localhost

Development

If you are part or want to be part of the developpers of this package, check development.md