php-bcrypt-converter

A TypeScript package for converting PHP bcrypt hashes to JavaScript bcrypt format. This package helps maintain compatibility between PHP and JavaScript applications that use bcrypt hashing.

Features

• Convert PHP bcrypt hashes ($2y$) to JavaScript format ($2b$)
• Preserve hash rounds and salt
• Full TypeScript support
• Comprehensive error handling
• Configurable strict mode
• 100% test coverage

Installation

1npm install php-bcrypt-converter
2# or
3yarn add php-bcrypt-converter

Usage

Basic Usage

1import { PhpBcryptConverter } from 'php-bcrypt-converter';
2
3const converter = new PhpBcryptConverter();
4
5// Convert a PHP bcrypt hash
6const result = converter.convert('$2y$10$abcdefghijklmnopqrstuv.wxyzABCDEFGHIJKLMNOPQRSTUVWXYZ');
7
8if (result.success) {
9  console.log(result.hash);    // '$2b$10$abcdefghijklmnopqrstuv.wxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
10  console.log(result.rounds);  // 10
11} else {
12  console.error(result.error);
13}

With Options

1const options = {
2  rounds: 12,     // Default rounds if needed
3  strict: false   // Don't throw errors for invalid hashes
4};
5
6const result = converter.convert(phpHash, options);

Error Handling

1// Strict mode (default)
2try {
3  const result = converter.convert(invalidHash);
4} catch (error) {
5  console.error('Invalid hash format');
6}
7
8// Non-strict mode
9const result = converter.convert(invalidHash, { strict: false });
10if (!result.success) {
11  console.error(result.error);
12}

API Reference

PhpBcryptConverter Class

constructor()

Creates a new instance of the converter.

convert(phpHash: string, options?: ConversionOptions): ConversionResult

Converts a PHP bcrypt hash to JavaScript format.

Parameters:

• phpHash: The PHP bcrypt hash to convert
• options (optional): Configuration options
  • rounds: Default number of rounds (default: 12)
  • strict: Whether to throw errors for invalid hashes (default: true)

Returns:

A ConversionResult object containing:

• hash: The converted JavaScript bcrypt hash
• rounds: Number of rounds detected from the hash
• success: Whether the conversion was successful
• error: Error message if conversion failed (only in non-strict mode)

Types

1interface ConversionOptions {
2  rounds?: number;
3  strict?: boolean;
4}
5
6interface ConversionResult {
7  hash: string;
8  rounds: number;
9  success: boolean;
10  error?: string;
11}

Development

Setup

1git clone https://github.com/Dippys/php-bcrypt-converter.git
2cd php-bcrypt-converter
3npm install

Running Tests

1npm test
2npm run test:watch  # Run tests in watch mode

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENCE file for details.

Acknowledgments

• Inspired by the need for PHP/JavaScript bcrypt compatibility
• Built with TypeScript for type safety and better developer experience

Support

For support, please open an issue in the GitHub repository.