cviebrock/artisan-hash

Adds Artisan tasks to Laravel to work with password hashes from the CLI.

v1.0.1 2014-04-25 20:23 UTC

Requires

• php: >=5.4.0
• illuminate/hashing: 4.*
• illuminate/support: 4.*

Requires (Dev)

• phpunit/phpunit: 3.7.*

MIT

• Colin Viebrock

README

Adds Artisan tasks to Laravel to work with password hashes from the CLI.

• Installation
• Usage
• Bugs, Suggestions and Contributions
• Copyright and License

Installation

First, add the package to the require-dev attribute of your composer.json file:

{
    "require": {
        "cviebrock/artisan-hash": "1.*"
    },
}

You could add it to the require section instead, but you likely only need this during development.

Next, update Composer from the Terminal:

composer update --dev

Once this operation completes, add the service provider. Open app/config/app.php, and add a new item to the providers array.

'Cviebrock\ArtisanHash\ArtisanHashServiceProvider'

That's it! Run the artisan command from the Terminal to see the new commands.

php artisan

Usage

hash:make

This will hash the given plaintext string and output the hash to the console. If you don't provide a string, you will be asked to enter one (this will keep the plaintext string out of your shell history).

$ php artisan hash:make foo
$2y$08$3nq5mD1faNAPUdyt72yyqOTRl/OIrizhQ84EnH1kbouC/8ud31smW

hash:check

This will compare a given hash to a plaintext string and see if they match.

$ php artisan hash:check '$2y$08$3nq5mD1faNAPUdyt72yyqOTRl/OIrizhQ84EnH1kbouC/8ud31smW' foo
Hash matches.

Note that if the hash contains dollar signs -- as it likely will -- you will need to escape them in your shell. The easiest way is just to surround the hash in single quotes, or don't provide the hash via the command and use the prompt.

The command will also check if the hash needs rehashing.

$ php artisan hash:check '$1$stCkrNrE$W92vGH25VHnLK.kDBmZwz0' foo
Hash matches.
Your hash needs to be rehashed.

Bugs, Suggestions and Contributions

Please use Github for bugs, comments, suggestions.

1. Fork the project.
2. Create your bugfix/feature branch and write your (well-commented) code.
3. Create unit tests for your code:
   • Run composer install --dev in the root directory to install required testing packages.
   • Add your test methods to artisan-hash/tests/.
   • Run vendor/bin/phpunit to the new (and all previous) tests and make sure everything passes.
4. Commit your changes (and your tests) and push to your branch.
5. Create a new pull request against the artisan-hash develop branch.

Please note that you must create your pull request against the develop branch.

Copyright and License

artisan-hash was written by Colin Viebrock and released under the MIT License. See the LICENSE file for details.

Copyright 2014 Colin Viebrock