bksanitizers

---

Table of contents

• Quick Start
• Status
• About
• Visuals
• Files
• Prerequisites
• Tests
• Contributing
• Community
• Authors
• LICENSE
• Comparing
• Sponsor
• Spread BK Sanitizers
• CODE_OF_CONDUCT
• Conclusion

Quick Start 🚀

• Download the latest version

• Clone the repo:

git clone https://github.com/PuneetGopinath/Sanitizers.git OR gh repo clone PuneetGopinath/Sanitizers

• Installation 🔧

See INSTALL.md file for Installation guide.

• Usage

Just include the file and Sanitize the user input.

• Example Usage without composer autoload:

<?php
// Import classes
use Sanitizers\Sanitizers\Sanitizer;

require "src/Sanitizers.php";

// passing `true` in Sanitize class enables exceptions
$sanitizer = new Sanitizer(true);
try {
    echo $sanitizer->sanitize("username", $_GET["username"]);
} catch (Exception $e) {
    echo "Could not Sanitize user input.";
    var_dump($e);
}
?>

• Example Usage with composer autoload:

<?php
// Import classes
use Sanitizers\Sanitizers\Sanitizer;

require "vendor/autoload.php";

$sanitizer = new Sanitizer(true);
try {
    echo $sanitizer->sanitize("username", $_GET["username"]);
} catch (Exception $e) {
    echo "Could not Sanitize user input.";
    var_dump($e);
}
?>

Status

Workflows

GitHub

Packagist

Stargazers

👏 Thank you very much stargazers ⭐ !!

You have proved that BK Sanitizers has some value !!

Stargazers over time

About ℹ️

• What is Sanitize ??

/ˈsanɪtʌɪz/ - to make something completely clean and free from bacteria.

In web development to sanitize means that you remove unsafe characters from the input.
Sanitize is a function to check (and remove) harmful data (which can harm the software) from user input.
Sanitizing user input is the most secure method of user input validation to strip out anything that is not on the whitelist.

• When and why should I use Sanitizers ?

Whenever you store user's data (in database or anywhere), or if that data will be read/available to (unsuspecting) users, then you have to sanitize it.
See also HTML_sanitization in wikipedia

• What is SQL injection ??

SQL injection is a method used by hackers to inject malicious SQL codes while running SQL query.

• How can I clean user input 🧹 ?

• First, Sanitize
• Then, Validate
• Last, Escape output.

Visuals 📽️

• Testing with and without composer autoload in Termux (on Android)

I ran:

composer validate # Validates composer.json
composer test # Test without composer autoload
composer update # Update dependencies and install autoload
composer test # Test with composer autoload

Files 🗃️

Sanitizers/
└── src/
    ├── Sanitizers.php
    └── config.ini
    └── bootstrap.php
└── examples/
    └── README.md
    └── confirm-reg.php
    └── contact-form.php
    └── login.php
    └── register.php
└── test/
    └── SanitizersTest.php
    └── README.md

Prerequisites 📋

• PHP

Minimum we need php 5.6.0 for Sanitizers to work.

• PHP Extensions

You need filter and mbstring extension.

Tests ⚙️

Run either composer run-script test or php test/SanitizersTest.php debug

Contributing

Plz read CONTRIBUTING.md file.

Community 💬

Get updates on Sanitizers's development and chat with the BKS maintainers and community members.

• Chat in IRC. On the irc.freenode.net server, in the #bksanitizers channel.
• Also you can chat in gitter
• Follow our blog on hashnode.dev
• We might send messages (as comments) in this discussion, you can read those when you are free !!

Authors ✒️

• Puneet Gopinath - PuneetGopinath

See also the list of contributors who participated in building this project.

LICENSE 📄

MIT License. Read LICENSE file.

Comparing 😕

Are you comparing BKS library with HTMLPurifier ??

Then, you need to know difference between HTMLPurifier and BKS

1. HTMLPurifier aims at creating safe and valid HTML as close as possible to a given input. But we aim to cover all types of input like name, username, password, etc

Sponsor

Support BK Sanitizers by becoming a sponsor. Your logo will be displayed here.

Just click the "Sponsor" button on our GitHub repo.

Become a sponsor

Spread BK Sanitizers! 🎉

Help spread awareness about BK Sanitizers by:

This is optional and you can also try to atleast give a star.

• Share in social media platforms.
• Add BK Sanitizers in your site's credits list OR add Powered by <a href="https://github.com/PuneetGopinath/Sanitizers/">BK Sanitizers</a>.
• Give a star in GitHub

CODE_OF_CONDUCT

Plz read CODE_OF_CONDUCT.md for our CODE OF CONDUCT.

Conclusion 🏁

If you sanitize user input then, you will be able to manage data properly, validate it, show it in a secure and reliable way.

It makes your web application trustworthy, so it must be one of your main goals from the beginning of your career as a web developer.