Skip to content

Replace OpenSSL with native CSPRNG for token generation #64

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
yann-eugone merged 1 commit into from
Dec 3, 2025
Merged

Replace OpenSSL with native CSPRNG for token generation #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
],
"require": {
"php": "^8.1",
"ext-openssl": "*",
"symfony/framework-bundle": "^6.4|^7.4|^8.0",
"doctrine/common": "^3.0",
"doctrine/orm": "^3.0",
Expand Down
4 changes: 2 additions & 2 deletions config/services.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,8 @@
<argument type="service" id="yokai_security_token.token_entity_repository"/>
</service>

<service id="yokai_security_token.open_ssl_token_generator"
class="Yokai\SecurityTokenBundle\Generator\OpenSslTokenGenerator"
<service id="yokai_security_token.bin2hex_token_generator"
class="Yokai\SecurityTokenBundle\Generator\Bin2HexTokenGenerator"
public="false"/>

<service id="yokai_security_token.default_information_guesser"
Expand Down
2 changes: 1 addition & 1 deletion doc/2-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Each token can have following options :

Default values fallback to :

- `generator` : [`yokai_security_token.open_ssl_token_generator`](../src/Generator/OpenSslTokenGenerator.php)
- `generator` : [`yokai_security_token.bin2hex_token_generator`](../src/Generator/Bin2HexTokenGenerator.php)
- `duration` : `+2 days`
- `usages` : `1`
- `keep` : `+1 month`
Expand Down
2 changes: 1 addition & 1 deletion src/DependencyInjection/Configuration.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ private function getTokensNode(): ArrayNodeDefinition
->prototype('array')
->children()
->scalarNode('generator')
->defaultValue('yokai_security_token.open_ssl_token_generator')
->defaultValue('yokai_security_token.bin2hex_token_generator')
->end()
->scalarNode('duration')
->defaultValue('+2 days')
Expand Down
30 changes: 30 additions & 0 deletions src/Generator/Bin2HexTokenGenerator.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
<?php

declare(strict_types=1);

namespace Yokai\SecurityTokenBundle\Generator;

/**
* This token generator is using `bin2hex` along with `random_bytes` to generate random token values.
*
* @author Yann Eugoné <eugone.yann@gmail.com>
*/
final class Bin2HexTokenGenerator implements TokenGeneratorInterface
{
public function __construct(
/**
* @var int<1, max> The token length
*/
private readonly int $length = 64,
) {
}

public function generate(): string
{
$byteLength = (int)\ceil($this->length / 2);
\assert($byteLength >= 1);
$hex = \bin2hex(\random_bytes($byteLength));

return \substr($hex, 0, $this->length);
}
}
28 changes: 0 additions & 28 deletions src/Generator/OpenSslTokenGenerator.php
View file
Open in desktop

This file was deleted.

33 changes: 33 additions & 0 deletions tests/Generator/Bin2HexTokenGeneratorTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

declare(strict_types=1);

namespace Yokai\SecurityTokenBundle\Tests\Generator;

use PHPUnit\Framework\Attributes\DataProvider;
use Yokai\SecurityTokenBundle\Generator\Bin2HexTokenGenerator;
use PHPUnit\Framework\TestCase;

final class Bin2HexTokenGeneratorTest extends TestCase
{
#[DataProvider('length')]
public function test_it_generate_unique_token(int $length): void
{
$generator = new Bin2HexTokenGenerator($length);

$tokens = [];
for ($i = 1; $i <= 1000; $i++) {
$tokens[] = $value = $generator->generate();
self::assertSame($length, \mb_strlen($value));
}

self::assertSame(\array_unique($tokens), $tokens);
}

public static function length(): \Generator
{
yield [64];
yield [10];
yield [11];
}
}
29 changes: 0 additions & 29 deletions tests/Generator/OpenSslTokenGeneratorTest.php
View file
Open in desktop

This file was deleted.

Loading