@rushstack/debug-certificate-manager
TypeScript icon, indicating that this package has built-in type declarations

1.3.40 • Public • Published

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

Readme

Keywords

none

Package Sidebar

Install

npm i @rushstack/debug-certificate-manager

Weekly Downloads

34,242

Version

1.3.40

License

MIT

Unpacked Size

107 kB

Total Files

21

Last publish

Collaborators

  • octogonz
  • odspnpm
  • rushstack-admin