PHP download

Download the PHP package muffin/obfuscate without Composer

On this page you can find all versions of the php package muffin/obfuscate. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

Table of contents
Download muffin/obfuscate
More information about muffin/obfuscate
Files in muffin/obfuscate

Vendor muffin
Package obfuscate
Short Description CakePHP support for ID obfuscation
License MIT
Homepage https://github.com/usemuffin/obfuscate

Keywords cakephp hash obfuscate muffin

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:

If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.

Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
To use Composer is sometimes complicated. Especially for beginners.
Composer needs much resources. Sometimes they are not available on a simple webspace.
If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.

Please rate this library. Is it a good library?

Example code of muffin/obfuscate

Informations about the package obfuscate

Obfuscate

Primary key obfuscation for CakePHP using HashIds, Optimus, Base62 and/or custom obfuscation strategies.

Installation

Install the plugin using Composer:

Load the plugin by either running this console command:

or by manually adding the following line to src/Application.php:

Lastly, install the required obfuscation library depending on the strategy class you want to use and stated below.

Built-in obfuscation strategies

Use the HashIdStrategy if you want to:

obfuscate your primary keys with short, unique, non-sequential ids
present record ids like 347 as strings like “yr8”

Use the OptimusStrategy if you want to:

obfuscate your primary keys with integers based on Knuth's integer hash
present record ids like 347 as integers like 372555994

Use the Base62Strategy if you want to:

obfuscate your primary keys with base62 strings and integers
present record ids like 347 as strings like "vk"

You can also create your own strategy classes by implementing the StrategyInterface.

Usage

1. Attaching the behavior

Prepare for obfuscation by attaching the Obfuscate behavior to your table(s) and specifying which strategy you want to use as shown in the following examples.

Please note that attaching the behavior is totally unobtrusive and will do absolutely nothing until you use one of the custom finders.

2. Using the custom finders

This plugin comes with the following two custom finders that are responsible for the actual obfuscation (cloaking) and elucidation (uncloaking) process:

findObfuscated: used to find records using an obfuscated (cloaked) primary key
findObfuscate: used to obfuscate (cloak) all primary keys in a find result set

findObfuscated

Use this finder if you want to look up a record using an obfuscated id. The plugin will elucidate (uncloak) the obfuscated id and will execute the find using the "normal" primary key as it is used inside your database.

CakePHP example:

Crud plugin example:

findObfuscate

Use this finder if you want the plugin to obfuscate all "normal" primary keys found in a find result set.

CakePHP example:

Crud plugin example:

Methods

Attaching the behavior also makes the following two methods available on the table:

obfuscate(string $str)
elucidate(string $str)

Pro tips

Authentication

A fairly common use case is applying obfuscation to user ids. To ensure the Authentication plugin properly handles obfuscated ids, specify the obfuscated finder using the finder key in your identifier's resolver config.

Patches & Features

Fork
Mod, fix
Test - this is important, so it's not unintentionally broken
Commit - do not mess with license, todo, version, etc. (if you do change any, bump them into commits of their own that I can ignore when I pull)
Pull request - bonus point for topic branches

To ensure your PRs are considered for upstream, you MUST follow the CakePHP coding standards.

Bugs & Feedback

http://github.com/usemuffin/obfuscate/issues

License

All versions of obfuscate with dependencies

PHP Build Version

Package Version

Version 3.0.1 Release 27. Sep 2023
create-project require 0 people choosed require and
0 people choosed create-project.

Download

Download latest version of obfuscate from vendor muffin

Requires cakephp/orm Version ^5.0.0

Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package muffin/obfuscate contains the following files

Loading the files please wait ....