npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

aegis-shield

v1.1.0

Published

**AegisShield** is a comprehensive TypeScript package for identifying, handling, and protecting Personally Identifiable Information (PII) in data. It provides functionality for detecting common PII fields, applying redaction, masking, or encryption based

Downloads

117

Readme

AegisShield

AegisShield is a comprehensive TypeScript package for identifying, handling, and protecting Personally Identifiable Information (PII) in data. It provides functionality for detecting common PII fields, applying redaction, masking, or encryption based on user configuration, and reversing these effects where possible.

Features

  • PII Detection: Identify common PII fields such as emails, phone numbers, credit card numbers, and more.
  • PII Handling:
    • Redaction: Replace detected PII with a placeholder (e.g., [REDACTED]).
    • Masking: Partially obscure PII (e.g., 1234****5678).
    • Encryption: Encrypt PII using a specified algorithm, key, and initialization vector (IV).
  • Reversal of Effects: Reverse the effects of masking and redaction where applicable, and decrypt encrypted data.

Installation

To install AegisShield, use npm:

npm install aegis-shield

Usage

Initialization

Initialize the AegisShield class with optional encryption configuration and field-specific configurations.

import { AegisShield } from 'aegis-shield';

const shield = new AegisShield({
  encryptionConfig: {
    algorithm: 'aes-256-cbc',
    key: Buffer.from('your-encryption-key-here', 'hex'),
    iv: Buffer.from('your-initialization-vector-here', 'hex')
  },
  fieldConfig: {
    email: { action: 'redact' },
    creditCardNumber: { action: 'mask' },
    ssn: { action: 'encrypt', encryptionKey: Buffer.from('field-specific-key', 'hex') }
  }
});

Handling PII

Handle PII in your data using the handlePii method. This method will process the data according to the provided field-specific configurations or default rules.

const sensitiveData = {
  email: '[email protected]',
  phoneNumber: '+1234567890',
  creditCardNumber: '4111111111111111',
  ssn: '123-45-6789'
};

const sanitizedData = shield.handlePii(sensitiveData);
console.log(sanitizedData);

Reversing Effects

Reverse the effects applied by the handlePii method (such as decrypting data) using the reverseEffects method.

const originalData = shield.reverseEffects(sanitizedData);
console.log(originalData);

API Reference

AegisShield(config: AegisShieldConfig)

  • config: Optional configuration object for encryption and field-specific actions.

handlePii(data: Record<string, any>): Record<string, any>

  • data: The object containing PII to be handled.
  • Returns: A new object with PII redacted, masked, or encrypted according to configuration.

reverseEffects(data: Record<string, any>): Record<string, any>

  • data: The object containing data with effects applied.
  • Returns: A new object with effects reversed (if applicable).

Encryption Configuration

The encryption configuration should include:

  • algorithm: The encryption algorithm (e.g., 'aes-256-cbc').
  • key: The encryption key as a Buffer.
  • iv: The initialization vector (IV) as a Buffer.

Example Encryption Configuration

const shield = new AegisShield({
  encryptionConfig: {
    algorithm: 'aes-256-cbc',
    key: Buffer.from('your-encryption-key-here', 'hex'),
    iv: Buffer.from('your-initialization-vector-here', 'hex')
  }
});

License

This package is licensed under the MIT License. See the LICENSE file for details.

The package is maintained by S25Digital