Download the PHP package goncalves-rodrigues/security-linter without Composer
On this page you can find all versions of the php package goncalves-rodrigues/security-linter. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download goncalves-rodrigues/security-linter
More information about goncalves-rodrigues/security-linter
Files in goncalves-rodrigues/security-linter
Package security-linter
Short Description Un linter pour la securité dun serv web en php
License MIT
Informations about the package security-linter
SecurityLinter
SecurityLinter est une bibliothèque PHP conçue pour analyser votre projet à la recherche de failles de sécurité courantes, comme les vulnérabilités liées au XSS (Cross-Site Scripting), et pour appliquer des corrections automatiques.
🚀 Fonctionnalités
- 🔍 Analyse de sécurité : Scanne vos fichiers à la recherche de problèmes de sécurité potentiels.
- 🛠️ Correction automatique : Identifie et corrige les failles XSS en encapsulant les superglobales (
$_GET,$_POST, etc.) dans une fonction de nettoyage. - 🗂️ Support de plusieurs fichiers et dossiers : Peut analyser un fichier spécifique ou un dossier entier.
- ⚡ Facilité d'utilisation : Une API simple et intuitive.
🛠️ Installation
Pré-requis :
- PHP 8.0 ou supérieur
- Composer
Étape 1 : Installer avec Composer
Vous pouvez ajouter ce package dans votre projet avec Composer :
Étape 2 : Autoload de Composer
Assurez-vous que votre projet utilise l'autoloader de Composer. Ajoutez cette ligne au fichier PHP principal si nécessaire :
🔧 Utilisation
1. Analyse et rapport des problèmes
La méthode scanAndReport permet de scanner un fichier ou un dossier et de générer un rapport des problèmes de sécurité.
2. Correction automatique des failles XSS dans un fichier
La méthode autoFixXSS identifie les parties vulnérables dans un fichier PHP et les corrige automatiquement.
Exemple avant la correction :
Exemple après la correction :
📚 Documentation des Méthodes
1. scanAndReport
Description :
- Scanne le fichier ou dossier spécifié pour détecter des problèmes de sécurité.
- Renvoie un tableau associatif contenant le chemin des fichiers en tant que clé et une liste des problèmes en tant que valeur.
Paramètres :
$path(string) : Chemin du fichier/dossier à scanner.
Retour :
- Un tableau des problèmes détectés.
2. autoFixXSS
Description :
- Scanne le fichier spécifié et remplace automatiquement les superglobales vulnérables (
$_GET,$_POST, etc.) par une encapsulation dans la fonction de nettoyage définie (par défaut :cleanXSSCustom).
Paramètres :
$filePath(string) : Chemin du fichier à corriger.
Retour :
- Aucun. Modifie directement le fichier.
🤝 Contribution
Vous souhaitez contribuer ? Voici comment :
-
Clonez ce dépôt :
-
Installez les dépendances via Composer :
-
Créez un nouveau branch pour votre contribution :
- Envoyez une pull request lorsque vous avez terminé vos modifications !
📄 Licence
Ce projet est sous licence MIT.
🙋 Support
Si vous avez des questions ou des problèmes, n'hésitez pas à ouvrir un problème (issue) sur le dépôt GitHub.
🌟 Remerciements
Merci d'utiliser SecurityLinter !