Skip to content

Files

Latest commit

 

History

History

debug-certificate-manager

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Sep 19, 2023
Sep 20, 2024
Sep 26, 2023
Jul 26, 2024
Mar 12, 2025
Mar 12, 2025
Jan 17, 2020
Feb 17, 2024
Mar 12, 2025
Sep 19, 2023

@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.

npm version

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

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