Skip to content

Latest commit

 

History

History
60 lines (41 loc) · 2.03 KB

README.md

File metadata and controls

60 lines (41 loc) · 2.03 KB
Raw

DPAPI

npm npm build coverage

Native module to encrypt/decrypt data on Windows with DPAPI.

This native module is prebuilt for Node.JS running on Windows. It provides the win32-x64 N-API module.

Based on the port to N-API made by Microsoft in @msal-node-extension from the work of Brad Hughes.

This package is part of the Primno framework.

Why this package?

Other similar packages require to build the native module on the target machine during the installation. This means that you must have Python and Visual C++ installed, production environment included.

This package is prebuilt, so you don't need to have build tools installed on the target machine.

Install

The win32-x64 prebuilt module will be installed with the following command.

npm install @primno/dpapi

Definition

function protectData(
    userData: Uint8Array,
    optionalEntropy: Uint8Array | null,
    scope: "CurrentUser" | "LocalMachine"
): Uint8Array;

function unprotectData(
    encryptedData: Uint8Array,
    optionalEntropy: Uint8Array | null,
    scope: "CurrentUser" | "LocalMachine"
): Uint8Array;

Usage

import { Dpapi } from "@primno/dpapi";

const buffer = Buffer.from("Hello world", "utf-8");

const encrypted = Dpapi.protectData(buffer, null, "CurrentUser");
const decrypted = Dpapi.unprotectData(encrypted, null, "CurrentUser");

Credits

  • Brad Hughes for the original code.
  • Microsoft for the N-API port in MSAL-Node-Extension.