Frieren : le micro-framework pour gadgets de sécurité

Description

Frieren est un framework permettant d'exécuter des outils de sécurité sur les routeurs OpenWrt et les cartes mono-carte (SBC). Il fournit un panneau web avec la gestion du WiFi, des modules installables, un terminal intégré et un gestionnaire de paquets. La pile est constituée d'une API backend en PHP avec un frontend React, conçue pour être suffisamment légère pour les appareils embarqués tout en restant extensible grâce à des modules tiers.

Fonctionnalités

• Gestion du WiFi — Créer, modifier et supprimer des interfaces sans fil. Rechercher des réseaux, configurer les radios, éditer la configuration UCI brute.
• Réseau — Gérer les interfaces réseau, consulter les baux DHCP et exécuter des diagnostics de connectivité.
• Système de modules — Installer, supprimer et épingler des modules tiers depuis un dépôt distant. Les modules se chargent dynamiquement sous forme de bundles UMD.
• Gestionnaire de paquets — Installer et supprimer des paquets opkg directement depuis le panneau web.
• Terminal intégré — Terminal web (ttyd) accessible depuis le panneau.
• Outils système — Tableau de bord avec statistiques système, liste des périphériques USB, utilisation du système de fichiers, visionneuse de syslog, diagnostics et contrôle des services init.d.
• Paramètres — Configurer le nom d'hôte, le fuseau horaire, le mot de passe utilisateur et le thème du panneau.
• Extensible — Générer de nouveaux modules avec frieren-module-template. Contrôleur PHP + frontend React par module.

Composants

• frieren-back — Micro-framework PHP. API JSON POST avec authentification par session, CSRF, intégration de la configuration UCI et un mini ORM.
• frieren-front — SPA React (Vite, Wouter, Jotai, React Query). Prend en charge le chargement dynamique de modules UMD.
• frieren-module-template — Outil de génération de squelette pour développer des modules tiers avec des dépendances partagées via des globales window.
• frieren-terminal — @frieren/terminal-core, une bibliothèque TypeScript/xterm.js intégrée au frontend. Fournit le client terminal ttyd en direct, une visionneuse de journaux en lecture seule et les thèmes de terminal partagés.
• tools — Outils de développement : proxy API de dev, script de déploiement sur appareil, client de test API et minificateur PHP.

Dépôts associés

• Frieren Modules : Contient des modules développés par la communauté sur la base du frieren-module-template. Ce dépôt est une ressource pour les utilisateurs souhaitant étendre les fonctionnalités de leur installation Frieren avec des fonctionnalités supplémentaires.
• Frieren Release : Héberge les installateurs pour déployer des versions précompilées de Frieren. Ce dépôt est idéal pour les utilisateurs qui souhaitent installer Frieren rapidement et facilement sans passer par le processus de compilation.
• Frieren Modules Release : Pipeline de compilation pour le catalogue de modules — génère l'index modules.json et les archives de version par module à partir desquelles le panneau effectue l'installation.

Installation

Frieren fonctionne sur OpenWrt (versions officielles, pas les forks). Il peut être installé via un script automatisé ou compilé manuellement.

Installation rapide

Pour une installation rapide et facile, exécutez la commande suivante dans votre terminal. Ce script gérera toutes les configurations et étapes de mise en place nécessaires :

wget -qO- https://raw.githubusercontent.com/xchwarze/frieren-release/master/install/install-openwrt.sh | sh

Novice ? Commencez ici. Si vous ne savez pas ce qu'est OpenWrt, comment le flasher ou comment ouvrir le panneau ensuite, suivez la FAQ d'installation pas à pas, conçue pour les débutants — elle vous guide de l'appareil vierge jusqu'à la connexion.

Compilation manuelle

Chaque composant du projet Frieren (frieren-back, frieren-front et frieren-module-template) possède son propre fichier README.md détaillé avec des instructions spécifiques de compilation et d'installation. Veuillez vous référer à ces fichiers dans leurs répertoires respectifs pour des conseils plus détaillés.

Développement de modules

Utilisez frieren-module-template pour générer de nouveaux modules. Exécutez yarn wizard pour configurer un nouveau module, développez votre fonctionnalité, puis yarn build pour compiler un bundle UMD. Consultez le README du modèle de module pour plus de détails.

Licence

Ce projet est sous licence PolyForm Noncommercial License 1.0.0.

L'utilisation non commerciale est autorisée. L'utilisation commerciale n'est pas autorisée dans le cadre de cette licence. L'utilisation commerciale nécessite une licence commerciale distincte auprès de l'auteur.

Pour une licence commerciale, contactez : [email protected]

Contribution

Les contributions sont les bienvenues — nouvelles fonctionnalités, corrections de bugs ou modules. Consultez le README de chaque composant pour les instructions de compilation.

Auteurs

• Développeur principal : DSR! - [email protected]

Soutenir le développement

Si vous trouvez Frieren utile, pensez à soutenir son développement. Les dons financent le matériel de test et le travail en cours. Envoyez-les via Binance ou rejoignez Patreon pour des mises à jour et des versions exclusives.