https://github.com/tetherto/pearpass-utils-password-check
PearPass is an open-source, privacy-first password manager with peer-to-peer syncing and end-to-end encryption. This repository contains shared core components used across the PearPass apps.
https://github.com/tetherto/pearpass-utils-password-check
Last synced: 3 months ago
JSON representation
PearPass is an open-source, privacy-first password manager with peer-to-peer syncing and end-to-end encryption. This repository contains shared core components used across the PearPass apps.
- Host: GitHub
- URL: https://github.com/tetherto/pearpass-utils-password-check
- Owner: tetherto
- License: apache-2.0
- Created: 2025-12-09T19:15:38.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2026-02-04T09:07:37.000Z (4 months ago)
- Last Synced: 2026-02-04T21:44:32.142Z (4 months ago)
- Language: JavaScript
- Homepage: https://pass.pears.com/
- Size: 94.7 KB
- Stars: 0
- Watchers: 0
- Forks: 8
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Notice: NOTICE
Awesome Lists containing this project
README
# pearpass-utils-password-check
A utility library to check the strength of passwords and passphrases based on configurable rules.
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Usage Examples](#usage-examples)
- [Dependencies](#dependencies)
- [Related Projects](#related-projects)
## Features
This utility provides functions to check the strength of passwords and passphrases based on configurable rules:
**Password Validation:**
- Minimum length requirements
- Uppercase and lowercase character inclusion
- Number inclusion
- Special character inclusion
**Passphrase Validation:**
- Minimum word count
- Unique words verification
- Capital letter inclusion
- Symbol inclusion
- Number inclusion
## Installation
```bash
npm install pearpass-utils-password-check
```
## Usage Examples
### Checking Password Strength
```javascript
import { checkPasswordStrength } from 'pearpass-utils-password-check';
// With default rules
const result = checkPasswordStrength('Test123!');
console.log(result.strengthType); // safe
// With custom rules
const customResult = checkPasswordStrength('Test1234', {
length: 8,
includeSpecialChars: false,
lowerCase: true,
upperCase: true,
numbers: true
});
console.log(customResult.strengthType); // safe
console.log(customResult.rules); // Detailed rules assessment
```
### Checking Passphrase Strength
```javascript
import { checkPassphraseStrength } from 'pearpass-utils-password-check';
// With default rules
const words = ['Test1!', 'Word2@', 'Example3#', 'Unique', 'Safe', 'Pass', 'Phrase', 'Another4$'];
const result = checkPassphraseStrength(words);
console.log(result.strength); // safe
// With custom rules
const customResult = checkPassphraseStrength(words, {
capitalLetters: true,
symbols: true,
numbers: true,
words: 6
});
console.log(customResult.strengthType); // safe
console.log(customResult.rules); // Detailed rules assessment
```
## Dependencies
This package has no runtime dependencies.
## Depended Submodules
The following sibling submodules must be present in the workspace (they are not declared as npm dependencies):
- [`tether-dev-docs`](../tether-dev-docs)
## Related Projects
- [pearpass-app-mobile](https://github.com/tetherto/pearpass-app-mobile) - A mobile app for PearPass, a password manager
- [pearpass-app-desktop](https://github.com/tetherto/pearpass-app-desktop) - A desktop app for PearPass, a password
- [pearpass-lib-ui-react-native-components](https://github.com/tetherto/pearpass-lib-ui-react-native-components) - A library of React Native UI components for PearPass
- [pearpass-lib-ui-react-components](https://github.com/tetherto/pearpass-lib-ui-react-components) - A library of React UI components for PearPass
- [tether-dev-docs](https://github.com/tetherto/tether-dev-docs) - Documentations and guides for developers
## License
This project is licensed under the Apache License, Version 2.0. See the [LICENSE](./LICENSE) file for details.