crypt-the-json/README.md

A utility for encrypting and decrypting JSON objects with selective field encryption

# JSON Object Crypto

A utility for encrypting and decrypting JSON objects with selective field encryption. This package allows you to encrypt specific fields in your JSON objects while keeping others in plain text.

## Features

- Encrypt and decrypt JSON objects
- Selective field encryption
- Support for nested objects and arrays
- Uses AES-256-CBC encryption by default
- Configurable encryption algorithm and encoding

## Installation

```bash
npm install crypt-the-json
```

## Usage

```javascript
const crypto = require("crypt-the-json");

// Example object
const data = {
  name: "John Doe",
  email: "john@example.com",
  password: "secret123",
  address: {
    street: "123 Main St",
    city: "New York",
  },
};

// Encrypt specific fields
const encrypted = crypto.encrypt(data, "your-secret-key");

// Decrypt the encrypted object
const decrypted = crypto.decrypt(encrypted, "your-secret-key");
```

## API

### `encrypt(object, password)`

Encrypts an object with the given password.

#### Parameters

- `object` (Object): The JSON object to encrypt
- `password` (string): The encryption password
- `config` (Object): Configuration options
  - `algorithm` (string): Encryption algorithm (default: 'aes-256-cbc')
  - `encoding` (string): Output encoding (default: 'hex')
  - `keys` (string[]): Optional array of keys to encrypt (if not provided, encrypts all fields)

### `decrypt(object, password)`

Decrypts an object with the given password.

#### Parameters

- `object` (Object): The JSON object to decrypt
- `password` (string): The decryption password
- `config` (Object): Configuration options
  - `algorithm` (string): Encryption algorithm (default: 'aes-256-cbc')
  - `encoding` (string): Input encoding (default: 'hex')
  - `keys` (string[]): Optional array of keys to decrypt (if not provided, decrypts all fields)

## License

MIT