PHP code example of oire / iridium

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

oire / iridium example snippets

use Oire\Iridium\Base64;
use Oire\Iridium\Exception\Base64Exception;

$text = "The quick brown fox jumps over the lazy dog";
$encoded = Base64::encode($text);
echo $encoded.PHP_EOL;

$encoded = Base64::encode($text, true);
echo $encoded.PHP_EOL;

$encoded = "VGhlIHF1aWNrIGJyb3duIGZveCBqdW1wcyBvdmVyIHRoZSBsYXp5IGRvZw";

try {
    $decoded = Base64::decode($encoded);
} catch(Base64Exception $e) {
    // Handle errors
}

echo $decoded.PHP_EOL;

use Oire\Iridium\Key\SharedKey;

$sharedKey = SharedKey::create();
$key = $sharedKey->getKey();
// Save the key instead
echo $key . PHP_EOL;

use Oire\Iridium\Crypt;
use Oire\Iridium\Key\SharedKey;

$data = 'Mischief managed!';
$sharedKey = new SharedKey($key);
$encrypted = Crypt::encrypt($data, $sharedKey);

$decrypted = Crypt::decrypt($encrypted, $sharedKey);

use Oire\Iridium\Exception\PasswordException;
use Oire\Iridium\Key\SharedKey;
use Oire\Iridium\Password;

// You should have $key somewhere in an environment variable
$sharedKey = new SharedKey($key);

try {
    $storeMe = Password::lock($_POST['password'], $sharedKey);
} catch (PasswordException $e) {
    // Handle errors
}

try {
    $isPasswordValid = Password::check($_POST['password'], $hashFromDatabase, $sharedKey);
} catch (PasswordException $e) {
    // Handle errors. Something went wrong: most often it's a wrong or corrupted key
}

if ($isPasswordValid) {
    // OK
} else {
    // Wrong password
}

if (Password::needsRehash($hashFromDatabase, $sharedKey)) {
    // Re-lock the password with the same key
    $newHash = Password::lock($_POST['password'], $sharedKey);
    // Store $newHash in the database
}

use Oire\Iridium\Storage\PdoTokenStorage;

$storage = new PdoTokenStorage($pdoConnection);
// Or with a custom table name:
$storage = new PdoTokenStorage($pdoConnection, 'my_tokens_table');

use Oire\Iridium\Storage\DoctrineDbalTokenStorage;

$storage = new DoctrineDbalTokenStorage($dbalConnection);
// From Doctrine ORM:
$storage = new DoctrineDbalTokenStorage($entityManager->getConnection());

use Oire\Iridium\SplitToken;
use Oire\Iridium\Storage\PdoTokenStorage;

// You should have set your $dbConnection first as a PDO instance
$storage = new PdoTokenStorage($dbConnection);
$splitToken =  SplitToken::create(
        storage: $storage,
        expirationTime: time() + 1800,
        userId: 123,
        tokenType: 3,
        additionalInfo: '{"some": "data"}'
    )
    ->persist();

use Oire\Iridium\Exception\InvalidTokenException;
use Oire\Iridium\SplitToken;

try {
    $splitToken = SplitToken::fromString($token, $storage);
} catch (InvalidTokenException $e) {
    // The token is invalid, not found, tampered with, expired or revoked
}

$splitToken = SplitToken::fromString($token, $storage, allowExpired: true);

if ($splitToken->isExpired()) {
    printf('This link expired on %s.', $splitToken->getExpirationDateFormatted());
}

// Given that $splitToken contains a valid token
$splitToken = $splitToken->revokeToken(true);

SplitToken::revokeBySelector($storage, $selector);
// Or, to delete the row rather than expire it:
SplitToken::revokeBySelector($storage, $selector, true);

$deletedTokens = SplitToken::clearExpiredTokens($storage);

// Keep about three months of revocation history.
$deletedTokens = $storage->clearExpiredBefore(time() - 90 * 86400);

shell
docker compose build
docker compose up -d
docker compose exec php composer install
docker compose exec php vendor/bin/phpunit

shell
docker compose exec php vendor/bin/psalm

shell
docker compose build
docker compose up -d
docker compose exec php composer install
docker compose exec php vendor/bin/phpunit
docker compose exec php vendor/bin/psalm
docker compose exec php vendor/bin/php-cs-fixer fix
docker compose down