Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hackzilla/password-generator

PHP Library to generate random passwords
https://github.com/hackzilla/password-generator

composer password-generator php php-library php8

Last synced: 7 days ago
JSON representation

PHP Library to generate random passwords

Host: GitHub
URL: https://github.com/hackzilla/password-generator
Owner: hackzilla
License: mit
Created: 2014-04-12T20:27:49.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2024-09-01T13:59:47.000Z (3 months ago)
Last Synced: 2024-11-28T09:03:16.726Z (14 days ago)
Topics: composer, password-generator, php, php-library, php8
Language: PHP
Homepage: https://hackzilla.org
Size: 217 KB
Stars: 292
Watchers: 8
Forks: 37
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-php - Password-Generator - PHP library to generate random passwords. (Table of Contents / Passwords)
awesome-php-cn - Password-Generator - PHP库生成随机密码. (目录 / 密码 Passwords)
awesome-projects - Password-Generator - PHP library to generate random passwords. (PHP / Passwords)
awesome-php - Password-Generator - PHP library to generate random passwords. (Table of Contents / Passwords)

README

        # Password Generator Library

Simple library for generating random passwords.

[![Latest Stable Version](https://poser.pugx.org/hackzilla/password-generator/v/stable.svg)](https://packagist.org/packages/hackzilla/password-generator)

[![Total Downloads](https://poser.pugx.org/hackzilla/password-generator/downloads.svg)](https://packagist.org/packages/hackzilla/password-generator)

[![Latest Unstable Version](https://poser.pugx.org/hackzilla/password-generator/v/unstable.svg)](https://packagist.org/packages/hackzilla/password-generator)

[![License](https://poser.pugx.org/hackzilla/password-generator/license.svg)](https://packagist.org/packages/hackzilla/password-generator)

## Requirements

* PHP >= 8.0

* ext-mbstring

## Installation

Install Composer

```

curl -sS https://getcomposer.org/installer | php

mv composer.phar /usr/local/bin/composer

```

Now tell composer to download the library by running the command:

``` bash

$ composer require hackzilla/password-generator

```

Composer will add the library to your composer.json file and install it into your project's `vendor/hackzilla` directory.

## Simple Usage

```php

use Hackzilla\PasswordGenerator\Generator\ComputerPasswordGenerator;

$generator = new ComputerPasswordGenerator();

$generator

  ->setOptionValue(ComputerPasswordGenerator::OPTION_UPPER_CASE, true)

  ->setOptionValue(ComputerPasswordGenerator::OPTION_LOWER_CASE, true)

  ->setOptionValue(ComputerPasswordGenerator::OPTION_NUMBERS, true)

  ->setOptionValue(ComputerPasswordGenerator::OPTION_SYMBOLS, false)

;

$password = $generator->generatePassword();

```

## More Passwords Usage

If you want to generate 10 passwords that are 12 characters long.

```php

use Hackzilla\PasswordGenerator\Generator\ComputerPasswordGenerator;

$generator = new ComputerPasswordGenerator();

$generator

  ->setUppercase()

  ->setLowercase()

  ->setNumbers()

  ->setSymbols(false)

  ->setLength(12);

$password = $generator->generatePasswords(10);

```

## Hybrid Password Generator Usage

```php

use Hackzilla\PasswordGenerator\Generator\HybridPasswordGenerator;

$generator = new HybridPasswordGenerator();

$generator

  ->setUppercase()

  ->setLowercase()

  ->setNumbers()

  ->setSymbols(false)

  ->setSegmentLength(3)

  ->setSegmentCount(4)

  ->setSegmentSeparator('-');

$password = $generator->generatePasswords(10);

```

If you can think of a better name for this password generator then let me know.

The segment separator will be remove from the possible characters.

## Human Password Generator Usage

```php

use Hackzilla\PasswordGenerator\Generator\HumanPasswordGenerator;

$generator = new HumanPasswordGenerator();

$generator

  ->setWordList('/usr/share/dict/words')

  ->setWordCount(3)

  ->setWordSeparator('-');

$password = $generator->generatePasswords(10);

```

## Requirement Password Generator Usage

```php

use Hackzilla\PasswordGenerator\Generator\RequirementPasswordGenerator;

$generator = new RequirementPasswordGenerator();

$generator

  ->setLength(16)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_UPPER_CASE, true)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_LOWER_CASE, true)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_NUMBERS, true)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_SYMBOLS, true)

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_UPPER_CASE, 2)

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_LOWER_CASE, 2)

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_NUMBERS, 2)

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_SYMBOLS, 2)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_UPPER_CASE, 8)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_LOWER_CASE, 8)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_NUMBERS, 8)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_SYMBOLS, 8)

;

$password = $generator->generatePassword();

```

A limit can be removed by passing ```null```

```php

$generator

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_UPPER_CASE, null)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_UPPER_CASE, null)

;

```

When setting the minimum and maximum values, be careful of unachievable settings.

For example the following will end up in an infinite loop.

```php

$generator

  ->setLength(4)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_UPPER_CASE, true)

  ->setOptionValue(RequirementPasswordGenerator::OPTION_LOWER_CASE, false)

  ->setMinimumCount(RequirementPasswordGenerator::OPTION_UPPER_CASE, 5)

  ->setMaximumCount(RequirementPasswordGenerator::OPTION_LOWER_CASE, 1)

;

```

For the moment you can call ```$generator->validLimits()``` to test whether the counts will cause problems.

If the method returns true, then you can proceed. If false, then generatePassword() will likely cause an infinite loop.

## Example Implementations

* Password Generator App [https://github.com/hackzilla/password-generator-app]

* Password Generator Bundle [https://github.com/hackzilla/password-generator-bundle]

## Random Note

Since version 1.5.0, the library depends on the presence of [random_int](http://www.php.net/random_int) which is found in PHP 7.0+

## Contributions and Issues

See all contributors on [GitHub](https://github.com/hackzilla/password-generator/graphs/contributors).

Please report issues using GitHub's issue tracker: [GitHub Repo](https://github.com/hackzilla/password-generator)

If you find this project useful, consider [buying me a coffee](https://www.buymeacoffee.com/hackzilla).

## License

This bundle is released under the MIT license. See the [LICENSE](https://github.com/hackzilla/password-generator/blob/main/LICENSE) file for details.