How to set up Optimus in Laravel?

Create a service provider to register a singleton Optimus instance with your prime numbers, then add it to config/app.php, as detailed in the README's Laravel integration section. This ensures dependency injection across controllers for easy encoding and decoding.

Optimus vs Hashids: which is better for my project?

Optimus is better if you need fast, integer-based hashes for URLs or APIs, while Hashids is preferable for string outputs or simpler setup. Optimus offers reversibility and performance but requires more initial configuration with prime numbers.

Can Optimus handle negative IDs or zero?

No, the library focuses on positive integers, as it uses multiplicative hashing with primes, which may not support negative values or zero without modifications. Check the README for constraints on input ranges.

Is Optimus secure enough for public APIs?

It provides obfuscation, not encryption, so it hides sequential patterns but shouldn't be used for sensitive data. The reversible nature means encoded IDs can be decoded if the prime numbers are known, limiting security for high-risk scenarios.

How to generate the prime numbers for Optimus?

Use the included console command 'php vendor/bin/optimus spark' to auto-generate primes, inverses, and random numbers, or provide your own prime from a list. The README explains this with examples for customization.

What happens if I lose the prime or inverse numbers?

You'll be unable to decode previously encoded IDs, as they are essential for the reversible hashing. The README warns to use the same values throughout your application, so store them securely in configuration.

Open-Awesome

Optimus

MITPHPv1.1.2

A PHP library for obfuscating integer IDs using Knuth's multiplicative hashing method, generating reversible integer hashes.

Visit Website GitHub

1.3k stars75 forks0 contributors

What is Optimus?

Optimus is a PHP library that obfuscates integer IDs using Knuth's multiplicative hashing method, transforming them into reversible integer hashes. It solves the problem of exposing sequential database IDs in URLs or APIs by generating non-sequential, yet decodable, integer representations.

Target Audience

PHP developers building web applications or APIs who need to hide sequential database IDs in URLs, query parameters, or API responses for security or aesthetic reasons.

Value Proposition

Developers choose Optimus for its speed, simplicity, and integer-based output, which is more efficient and URL-friendly than string-based alternatives like Hashids, while maintaining full reversibility.

Overview

🤖 Id obfuscation based on Knuth's multiplicative hashing method for PHP.

Use Cases

Best For

Obfuscating auto-incrementing database IDs in REST API responses
Hiding sequential user or product IDs in URL parameters
Securing internal IDs in public-facing applications without using UUIDs
Integrating ID transformation into Laravel applications via service providers
Generating non-sequential but reversible integer tokens for analytics or tracking

Not Ideal For

Applications requiring irreversible cryptographic hashing for sensitive data like passwords
Projects needing string-based hashes for compatibility with frontend libraries or existing APIs
Non-PHP environments or teams using other programming languages for ID handling

Pros & Cons

Pros

Integer-Based Output

Generates integers instead of strings, making it ideal for URL parameters and API responses where integers are preferred, as stated in the README's focus on URL-friendly obfuscation.

High Performance

Optimized for speed with minimal overhead, using Knuth's multiplicative hashing method, which is emphasized as 'super fast' in the README for high-traffic applications.

Reversible Encoding

Allows lossless decoding back to original IDs via a mathematical formula, ensuring data integrity without external storage, as shown in the encode/decode examples.

Framework Integration

Includes built-in Laravel support and third-party packages for Silex and PSR-15, reducing integration effort in PHP ecosystems, with code examples provided.

Cons

Complex Setup

Requires manual generation and management of prime, inverse, and random numbers using the CLI tool, adding overhead compared to zero-configuration alternatives like Hashids.

Dependency on GMP Extension

For 32-bit systems or large primes, the GMP extension must be installed separately, as noted in the README, introducing potential compatibility and deployment hurdles.

Limited Ecosystem

Less community adoption than string-based tools like Hashids, with fewer third-party integrations and resources, which may increase maintenance risk for some projects.

Open Source Alternative To

Optimus is an open-source alternative to the following products:

Hashids

Hashids is a small open-source library that generates short, unique, non-sequential IDs from numbers, often used for URL shortening or obfuscating database IDs.

Frequently Asked Questions

Related Projects

SQLMap

Automatic SQL injection and database takeover tool

The ZAP by Checkmarx Core project

PHP Secure Communications Library

Simple Encryption in PHP.

Stars3,866

Forks310

Last commit2 years ago

Community-curated · Updated weekly · 100% open source

Found a gem we're missing?

Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.

Submit a project Star on GitHub

Optimus

MITPHPv1.1.2

A PHP library for obfuscating integer IDs using Knuth's multiplicative hashing method, generating reversible integer hashes.

Visit Website GitHub

1.3k stars75 forks0 contributors

What is Optimus?

Target Audience

PHP developers building web applications or APIs who need to hide sequential database IDs in URLs, query parameters, or API responses for security or aesthetic reasons.

Value Proposition

Overview

🤖 Id obfuscation based on Knuth's multiplicative hashing method for PHP.

Use Cases

Best For

Obfuscating auto-incrementing database IDs in REST API responses
Hiding sequential user or product IDs in URL parameters
Securing internal IDs in public-facing applications without using UUIDs
Integrating ID transformation into Laravel applications via service providers
Generating non-sequential but reversible integer tokens for analytics or tracking

Not Ideal For

Applications requiring irreversible cryptographic hashing for sensitive data like passwords
Projects needing string-based hashes for compatibility with frontend libraries or existing APIs
Non-PHP environments or teams using other programming languages for ID handling

Pros & Cons

Pros

Integer-Based Output

Generates integers instead of strings, making it ideal for URL parameters and API responses where integers are preferred, as stated in the README's focus on URL-friendly obfuscation.

High Performance

Optimized for speed with minimal overhead, using Knuth's multiplicative hashing method, which is emphasized as 'super fast' in the README for high-traffic applications.

Reversible Encoding

Allows lossless decoding back to original IDs via a mathematical formula, ensuring data integrity without external storage, as shown in the encode/decode examples.

Framework Integration

Includes built-in Laravel support and third-party packages for Silex and PSR-15, reducing integration effort in PHP ecosystems, with code examples provided.

Cons

Complex Setup

Requires manual generation and management of prime, inverse, and random numbers using the CLI tool, adding overhead compared to zero-configuration alternatives like Hashids.

Dependency on GMP Extension

For 32-bit systems or large primes, the GMP extension must be installed separately, as noted in the README, introducing potential compatibility and deployment hurdles.

Limited Ecosystem

Less community adoption than string-based tools like Hashids, with fewer third-party integrations and resources, which may increase maintenance risk for some projects.

Open Source Alternative To

Optimus is an open-source alternative to the following products:

Hashids

Hashids is a small open-source library that generates short, unique, non-sequential IDs from numbers, often used for URL shortening or obfuscating database IDs.