Repository files navigation

With this library, you can transform your internal id's to obfuscated integers based on Knuth's integer hash. It is similar to Hashids, but will generate integers instead of random strings. It is also super fast.

Install using composer:

composer require jenssegers/optimus

If you will be running your code on a 32 bit system or will be working with large prime numbers it is suggested that you install theGMP extension.For debian/ubuntu you can install the extension with one of these commands:

apt-get install php7.4-gmpapt-get install php8.0-gmpapt-get install php8.1-gmp

To get started you will need 3 things;

• Large prime number lower than2147483647
• The inverse prime so that(PRIME * INVERSE) & MAXID == 1
• A large random integer lower than2147483647

Luckily for you, I have included a console command that can do all of this for you. To get started, just run the following command:

> php vendor/bin/optimus sparkPrime: 2123809381Inverse: 1885413229Random: 146808189

If you prefer to choose your own prime number (fromthis list for example), you can pass it to the command to calculate the remaining numbers:

> php vendor/bin/optimus spark 1580030173Prime: 1580030173Inverse: 59260789Random: 1163945558

Using those numbers, you can start creating instances ofOptimus($prime, $inverted, $random):

useJenssegers\Optimus\Optimus;newOptimus(1580030173,59260789,1163945558);

NOTE: Make sure that you are using the same constructor values throughout your entire application!

To encode id's, use theencode method:

$encoded =$optimus->encode(20);// 1535832388

To decode the resulting1535832388 back to its original value, use thedecode method:

$original =$optimus->decode(1535832388);// 20

This is an example service provider which registers a shared Optimus instance for your entire application:

<?phpnamespaceApp\Providers;useJenssegers\Optimus\Optimus;useIlluminate\Support\ServiceProvider;class OptimusServiceProviderextends ServiceProvider{publicfunctionregister()    {$this->app->singleton(Optimus::class,function ($app) {returnnewOptimus(1580030173,59260789,1163945558);        });    }}

Once you have created the service provider, add it to the providers array in yourconfig/app.php configuration file:

App\Providers\OptimusServiceProvider::class,

Laravel's automatic injection will pass this instance where needed. Example controller:

<?phpnamespaceApp\Http\Controllers;useJenssegers\Optimus\Optimus;useApp\Http\Controllers\Controller;class UserControllerextends Controller{publicfunctionshow($id,Optimus$optimus)    {$id =$optimus->decode($id);    }}

More information:https://laravel.com/docs/5.3/container#resolving

Third-party integrations

• An integration with Laravel is provided by thepropaganistas/laravel-fakeid package.
• Laravel Optimus with multiple connections provided by thecybercog/laravel-optimus package.
• An integration with Silex 2 is provided by thejaam/silex-optimus-provider package.
• An integration with Laravel is provided by theelfsundae/laravel-hashid package.
• A PSR-15 middleware provided by theicanhazstring/optimus-middleware package.

To report a security vulnerability, followthese steps.

TheMIT License.