https://github.com/utopia-php/auth
Lite & fast micro PHP auth library that is **easy to use**.
https://github.com/utopia-php/auth
Last synced: about 1 month ago
JSON representation
Lite & fast micro PHP auth library that is **easy to use**.
- Host: GitHub
- URL: https://github.com/utopia-php/auth
- Owner: utopia-php
- License: mit
- Created: 2025-03-08T08:23:23.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-10-20T09:56:05.000Z (5 months ago)
- Last Synced: 2025-10-22T14:21:33.377Z (5 months ago)
- Language: PHP
- Size: 3.07 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Utopia Auth
[](https://travis-ci.org/utopia-php/auth)
[](https://appwrite.io/discord)
Utopia Auth library is a simple and lite library for handling authentication and authorization in PHP applications. This library provides a collection of secure hashing algorithms and authentication proofs for building robust authentication systems. This library is maintained by the [Appwrite team](https://appwrite.io).
Although this library is part of the [Utopia Framework](https://github.com/utopia-php/framework) project it is dependency free and can be used as standalone with any other PHP project or framework.
## Getting Started
Install using composer:
```bash
composer require utopia-php/auth
```
## System Requirements
Utopia Framework requires PHP 8.0 or later. We recommend using the latest PHP version whenever possible.
## Features
### Supported Hashing Hashes
- **Argon2** - Modern, secure, and recommended password hashing algorithm
- **Bcrypt** - Well-established and secure password hashing
- **Scrypt** - Memory-hard password hashing algorithm
- **ScryptModified** - Modified version of Scrypt with additional features
- **SHA** - Various SHA hash implementations
- **PHPass** - Portable password hashing framework
- **MD5** (Not recommended for passwords, legacy support only)
## Usage
### Data Store
```php
set('userId', '12345')
->set('name', 'John Doe')
->set('isActive', true)
->set('preferences', ['theme' => 'dark', 'notifications' => true]);
// Get values with optional defaults
$userId = $store->get('userId');
$missing = $store->get('missing', 'default value');
// Encode store data to a base64 string
$encoded = $store->encode();
// Later, decode the string back into a store
$newStore = new Store();
$newStore->decode($encoded);
// Access the decoded data
echo $newStore->get('name'); // Outputs: John Doe
```
### Password Hashing
```php
hash('user-password');
// Verify the password
$isValid = $password->verify('user-password', $hash);
// Use a specific algorithm with custom parameters
$bcrypt = new Bcrypt();
$bcrypt->setCost(12); // Increase cost factor for better security
$password->setHash($bcrypt);
$hash = $password->hash('user-password');
```
### Authentication Tokens
```php
generate(); // Random token
$hashedToken = $token->hash($authToken); // Store this in database
// Later, verify the token
$isValid = $token->verify($authToken, $hashedToken);
```
### One-Time Codes
```php
generate();
$hashedCode = $code->hash($verificationCode);
// Verify the code
$isValid = $code->verify($verificationCode, $hashedCode);
```
### Human-Readable Phrases
```php
generate(); // e.g., "Brave cat"
$hashedPhrase = $phrase->hash($authPhrase);
// Verify the phrase
$isValid = $phrase->verify($authPhrase, $hashedPhrase);
```
### Advanced Hash Configuration
```php
setCpuCost(16) // CPU/Memory cost parameter
->setMemoryCost(14) // Memory cost parameter
->setParallelCost(2) // Parallelization parameter
->setLength(64) // Output length in bytes
->setSalt('randomsalt123'); // Custom salt
// Configure Argon2 parameters
$argon2 = new Argon2();
$argon2
->setMemoryCost(65536) // Memory cost in KiB
->setTimeCost(4) // Number of iterations
->setThreads(3); // Number of threads
```
## Tests
To run all unit tests, use the following Docker command:
```bash
docker compose exec tests vendor/bin/phpunit --configuration phpunit.xml tests
```
To run static code analysis, use the following Psalm command:
```bash
docker compose exec tests vendor/bin/psalm --show-info=true
```
## Security
We take security seriously. If you discover any security-related issues, please email security@appwrite.io instead of using the issue tracker.
## Contributing
All code contributions - including those of people having commit access - must go through a pull request and be approved by a core developer before being merged. This is to ensure a proper review of all the code.
We truly ❤️ pull requests! If you wish to help, you can learn more about how you can contribute to this project in the [contribution guide](CONTRIBUTING.md).
## Copyright and license
The MIT License (MIT) [http://www.opensource.org/licenses/mit-license.php](http://www.opensource.org/licenses/mit-license.php)