4.0.1 • Published 4 months ago

secure-keyz v4.0.1

Weekly downloads
-
License
ISC
Repository
-
Last release
4 months ago

🔐 Secure-KeyZ

A powerful, flexible PassKey generation tool designed for security-conscious users

Version

Features

  • Strong Security: Generate cryptographically secure passwords with high entropy
  • Flexible Options: Customize PassKey length, character sets, and complexity
  • Memorability Features: Create passwords that are both secure and easy to remember
  • Security Analysis: Evaluate existing passwords on strength and composition
  • Modern CLI: Beautiful command-line interface with colorful outputs
  • TypeScript Support: Full TypeScript interface and documentation

Installation

# Install globally
npm install -g secure-keyz

# Or install locally
npm install secure-keyz

Quick Start

# Generate a default secure PassKey
secure-keyz

# Generate a memorable 20-character PassKey
secure-keyz --length 20 --memorable

# Analyze an existing password
secure-keyz --analyze "MyCurrentPassword123!"

CLI Usage

# Show help information
secure-keyz --help

Options

OptionAliasDescriptionDefault
--length <number>-lPassKey length16
--no-numbers-nExclude numerical characters(numbers included)
--no-special-sExclude special characters(specials included)
--no-emojis-eExclude emoji decorations(emojis included)
--memorable-mGenerate memorable PassKeyfalse
--custom <chars>-cAdd custom character set""
--no-similarExclude similar-looking characters(similar excluded)
--analyze <passkey>-aAnalyze passkey strength
--validate <passkey>-vValidate passkey against min strength
--min-strength <number>Minimum strength for validation3

Programmatic Usage

Basic Password Generation

import { PassKeyGenerator } from 'secure-keyz';

// Generate default PassKey
const passKey = PassKeyGenerator.generatePassKey();
console.log(passKey);  // Example: "j5K@pT8!F2xB&r0D🔒"

// Custom PassKey generation
const customPassKey = PassKeyGenerator.generatePassKey({
  length: 24,
  includeNumbers: false,
  memorable: true
});
console.log(customPassKey);  // Example: "xPwKeHgJvZqByTmRfNhS-dragon"

Password Analysis

import { PassKeyGenerator } from 'secure-keyz';

// Analyze a password's strength and characteristics
const analysis = PassKeyGenerator.analyzePassKey("MySecurePassw0rd!");
console.log(analysis);
/*
{
  length: 16,
  complexity: 'strong',
  entropyBits: 73.76,
  containsEmoji: false,
  specialCharCount: 1
}
*/

// Validate if a password meets minimum requirements
const isValid = PassKeyGenerator.validatePassKey("WeakPw", 3);
console.log(isValid);  // false - doesn't meet 'strong' requirement

Configuration Options

The PassKeyOptions interface gives you full control over password generation:

OptionTypeDefaultDescription
lengthnumber16Length of generated PassKey (8-64)
includeNumbersbooleantrueInclude digits 2-9
includeSpecialCharsbooleantrueInclude special symbols
includeEmojisbooleantrueAdd a decorative emoji
excludeSimilarCharsbooleantrueRemove confusing chars like l/1/O/0
customCharSetstring""Add additional custom characters
memorablebooleanfalseCreate human-friendly passwords

Security Features

  • Uses Node.js crypto module for secure randomness
  • Removes visually confusing characters by default
  • Complexity rating system (weak, medium, strong, excellent)
  • Entropy calculation for quantitative security measurement

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the ISC License - see the LICENSE file for details.

4.0.1

4 months ago

4.0.0

6 months ago

3.5.0

6 months ago

3.3.0

6 months ago

3.2.0

6 months ago

3.0.7

7 months ago

3.0.6

7 months ago

3.0.5

7 months ago

3.0.1

7 months ago

3.0.0

7 months ago

2.0.0

7 months ago

1.0.0

7 months ago