https://github.com/apollo917/pwdr

A utility for generating deterministic passwords based on a phrase and key
https://github.com/apollo917/pwdr

commonjs-module esmodule javascript node password pwd pwdr

Last synced: about 2 months ago
JSON representation

A utility for generating deterministic passwords based on a phrase and key

• Host: GitHub
• URL: https://github.com/apollo917/pwdr
• Owner: Apollo917
• License: mit
• Created: 2024-10-07T18:28:25.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-10-09T16:42:07.000Z (12 months ago)
• Last Synced: 2024-12-02T21:14:26.723Z (10 months ago)
• Topics: commonjs-module, esmodule, javascript, node, password, pwd, pwdr
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/pwdr
• Size: 55.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# 🔣 Pwdr

A utility for generating deterministic passwords using a phrase and key

[![version](https://img.shields.io/npm/v/pwdr?style=for-the-badge)](https://www.npmjs.com/package/pwdr)

[![license](https://img.shields.io/npm/l/pwdr?style=for-the-badge)](https://github.com/Apollo917/pwdr/blob/main/LICENSE)

[![size](https://img.shields.io/bundlephobia/minzip/pwdr?style=for-the-badge)](https://bundlephobia.com/result?p=pwdr)

[![downloads](https://img.shields.io/npm/dw/pwdr?style=for-the-badge)](https://www.npmjs.com/package/pwdr)



## 📦 Installation

```bash

npm i pwdr

```

## 🚀 Quickstart

```javascript

import { generatePwd } from 'pwdr';

const encoder = new TextEncoder();

const phrase = encoder.encode('phrase');

const key = encoder.encode('key');

const pwdBuffer = await generatePwd(phrase, key);

```

```javascript

import { generatePwd, erase } from 'pwdr';

const encoder = new TextEncoder();

const decoder = new TextDecoder();

const phrase = encoder.encode('phrase');

const key = encoder.encode('key');

const salt = encoder.encoding('salt');

const pwdBuffer = await generatePwd(phrase, key, { length: 32, iterations: 1_000_000, salt });

const pwd = decoder.decode(pwdBuffer);

erase(phrase, key, salt, pwdBuffer);

```

### 🔢 Resulting password

- Minimum length: 16

- Maximum length: 64

- Default length: 32

## 🔁 Version compatibility check

- phrase: `compatibility_check_phrase`

- key: `compatibility_check_key`

- length: `32`

### 🏷️ Versions

- **v1.x.x**

    - result: `1e9/wtB["D0NS/oCa/ra9p,v'NHBT4GQ`

- **v2.x.x**

    - result: `Ey,7Lg#4Vp(9Dg^2Nm_3Rm@5Bv!5Zj^8`