@rushstack/debug-certificate-manager

@rushstack/debug-certificate-manager

Installation

npm install @rushstack/debug-certificate-manager --save-dev

Overview

This library contains utilities for managing debug certificates in a development server environment. It provides functions to generate, self-sign, trust, and untrust .pem certificates for both Windows and Mac OS. It will also generate self-signed certificates on other OS's, but the user must manually trust and untrust them.

CertificateStore

The CertificateStore class provides accessors and mutators for the debug certificate data stored in .rushstack.

Retrive certificate data from the store:

const certificateStore: CertificateStore = new CertificateStore();
return {
  pemCertificate: certificateStore.certificateData,
  pemKey: certificateStore.keyData
};

Set data using the same property names certificateData: string | undefined and keyData: string | undefined.

ensureCertificate

Get a development certificate from the store, or optionally, generate a new one and trust it if one does not exist in the store. Returns a certificate object following the ICertificate interface.

export interface ICertificate {
  pemCertificate: string | undefined;
  pemKey: string | undefined;
}

untrustCertificate

Attempts to locate a previously generated debug certificate and untrust it. Returns a boolean value to denote success.

Links

• CHANGELOG.md - Find out what's new in the latest version
• API Reference

@rushstack/debug-certificate-manager is part of the Rush Stack family of projects.