# cryptbrau

> Simple in-browser encryption (symmetric).

Latest version **1.0.1** (published 2026-02-18) · MIT license · 0 weekly downloads

## Install

```sh
npm install cryptbrau
pnpm add cryptbrau
yarn add cryptbrau
bun add cryptbrau
```

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2026-02-18 |
| First published | 2017-09-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 628.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | steven velozo |
| Maintainers | stevenvelozo |

## Links

- npm: https://www.npmjs.com/package/cryptbrau
- Repository: https://stevenvelozo@github.com/stevenvelozo/cryptbrau
- Homepage: https://github.com/stevenvelozo/cryptbrau#readme
- Issues: https://github.com/stevenvelozo/cryptbrau/issues
- npm.io page: https://npm.io/package/cryptbrau

## Dependencies (1)

- [simple-encryptor](https://npm.io/package/simple-encryptor.md) ^1.1.0

## Recent versions

- 1.0.1 (latest) — 2026-02-18
- 1.0.0 — 2017-09-19

## README

# CryptBrau

Simple symmetric encryption for Node.js and the browser. Wraps the [simple-encryptor](https://www.npmjs.com/package/simple-encryptor) library with a key+salt configuration pattern and lazy encryptor initialization.

[![npm version](https://badge.fury.io/js/cryptbrau.svg)](https://badge.fury.io/js/cryptbrau)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

---

## Features

- **Symmetric Encryption** - Encrypt and decrypt messages with a shared key and salt
- **Lazy Initialization** - The encryptor is created on first use, not at construction time
- **Key + Salt Pattern** - Concatenates a key and salt string to build the full encryption key, with automatic minimum-length padding
- **Browser Compatible** - Works in both Node.js and browser environments via the bundled browser shim

## Installation

```bash
npm install cryptbrau
```

## Quick Start

```javascript
const cryptBrau = require('cryptbrau');

let encryptor = cryptBrau({ Key: 'MySecretKey', Salt: 'MySaltValue' });

let encrypted = encryptor.encrypt('Hello, World!');
console.log('Encrypted:', encrypted);

let decrypted = encryptor.decrypt(encrypted);
console.log('Decrypted:', decrypted); // "Hello, World!"
```

## Usage

### Object Configuration

Pass an options object with `Key` and `Salt` properties:

```javascript
let encryptor = cryptBrau({ Key: 'SomeVerySecureKeyReally', Salt: 'SomeKindOfSalt' });
```

### String Shorthand

Pass a string directly and it will be used as the key with a default salt:

```javascript
let encryptor = cryptBrau('MySecretKey');
```

### Browser Usage

Include the browser bundle and access via `window.cryptBrau`:

```html
<script src="lib/cryptbrau.js"></script>
<script>
    var encryptor = cryptBrau({ Key: 'BrowserKey', Salt: 'BrowserSalt' });
    var encrypted = encryptor.encrypt('Secret message');
</script>
```

## API

### `cryptBrau(pOptions)`

Create an encryptor instance.

| Parameter | Type | Description |
|-----------|------|-------------|
| `pOptions` | `Object` or `String` | Configuration object with `Key` and `Salt`, or a string used as the key |

Returns an encryptor object with `encrypt` and `decrypt` methods.

**Options:**

| Property | Type | Default | Description |
|----------|------|---------|-------------|
| `Key` | `String` | `'ThisIsNotSecureEnough.'` | The encryption key |
| `Salt` | `String` | `'0000000000000000'` | Salt appended to the key |

The key and salt are concatenated to form the full encryption key. If the combined string is shorter than 16 characters, it is padded automatically.

### `encryptor.encrypt(pMessage)`

Encrypt a message string. Returns the encrypted string.

### `encryptor.decrypt(pMessage)`

Decrypt an encrypted message string. Returns the original plaintext.

## Part of the Retold Framework

CryptBrau is used in the Pict ecosystem for client-side encryption:

- [pict](https://github.com/stevenvelozo/pict) - UI framework
- [fable](https://github.com/stevenvelozo/fable) - Application services framework

## Related Packages

- [fable](https://github.com/stevenvelozo/fable) - Application services framework

## License

MIT

## Contributing

Pull requests are welcome. For details on our code of conduct, contribution process, and testing requirements, see the [Retold Contributing Guide](https://github.com/stevenvelozo/retold/blob/main/docs/contributing.md).

---
_Source: https://npm.io/package/cryptbrau · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._