gandalf/secubox-openwrt
gandalf/secubox-openwrt
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ce543762cc
secubox-openwrt/site/validation-guide/index.html
CyberMind-FR ce543762cc chore: Update GitHub repo URL to CyberMind-FR organization 
Replace github.com/gkerma/secubox-openwrt with
github.com/CyberMind-FR/secubox-openwrt across all files.

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-14 09:44:01 +01:00

2719 lines
92 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="OpenWrt LuCI Security & Management Suite">
<meta name="author" content="CyberMind.fr">
<link rel="canonical" href="https://gkerma.github.io/secubox-openwrt/validation-guide/">
<link rel="prev" href="../claude/">
<link rel="next" href="../permissions-guide/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
<title>Validation Guide - SecuBox Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.484c7ddc.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.ab4e12ef.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#secubox-module-validation-guide" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<div data-md-color-scheme="default" data-md-component="outdated" hidden>
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="SecuBox Documentation" class="md-header__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
SecuBox Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Validation Guide
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="purple" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
<div class="md-search__suggest" data-md-component="search-suggest"></div>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item">
<a href="../quick-start/" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../development-guidelines/" class="md-tabs__link">
Development
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../claude/" class="md-tabs__link">
Reference
</a>
</li>
<li class="md-tabs__item">
<a href="../module-status/" class="md-tabs__link">
Modules
</a>
</li>
<li class="md-tabs__item">
<a href="../todo-analyse/" class="md-tabs__link">
Tools & Roadmap
</a>
</li>
<li class="md-tabs__item">
<a href="../archive/" class="md-tabs__link">
Archive
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="SecuBox Documentation" class="md-nav__button md-logo" aria-label="SecuBox Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
SecuBox Documentation
</label>
<div class="md-nav__source">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
gkerma/secubox-openwrt
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Getting Started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../quick-start/" class="md-nav__link">
<span class="md-ellipsis">
Quick Start
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../documentation-index/" class="md-nav__link">
<span class="md-ellipsis">
Documentation Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../repository-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Repository Guidelines
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
Development
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Development
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../development-guidelines/" class="md-nav__link">
<span class="md-ellipsis">
Development Guidelines
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../code-templates/" class="md-nav__link">
<span class="md-ellipsis">
Code Templates
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../module-implementation-guide/" class="md-nav__link">
<span class="md-ellipsis">
Module Implementation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" checked>
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="">
<span class="md-ellipsis">
Reference
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../claude/" class="md-nav__link">
<span class="md-ellipsis">
RPCD & Architecture
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Validation Guide
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Validation Guide
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#see-also" class="md-nav__link">
<span class="md-ellipsis">
See Also
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validation-tools" class="md-nav__link">
<span class="md-ellipsis">
Validation Tools
</span>
</a>
<nav class="md-nav" aria-label="Validation Tools">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-validate-module-generationsh" class="md-nav__link">
<span class="md-ellipsis">
1. validate-module-generation.sh
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-pre-push-validationsh" class="md-nav__link">
<span class="md-ellipsis">
2. pre-push-validation.sh
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-validate-modulessh" class="md-nav__link">
<span class="md-ellipsis">
3. validate-modules.sh
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#installing-git-hooks" class="md-nav__link">
<span class="md-ellipsis">
Installing Git Hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#critical-naming-conventions" class="md-nav__link">
<span class="md-ellipsis">
Critical Naming Conventions
</span>
</a>
<nav class="md-nav" aria-label="Critical Naming Conventions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-rpcd-script-must-match-ubus-object" class="md-nav__link">
<span class="md-ellipsis">
1. RPCD Script MUST Match ubus Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-menu-paths-must-match-view-file-locations" class="md-nav__link">
<span class="md-ellipsis">
2. Menu Paths MUST Match View File Locations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-all-ubus-objects-must-use-luci-prefix" class="md-nav__link">
<span class="md-ellipsis">
3. All ubus Objects MUST Use luci. Prefix
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#module-generation-checklist" class="md-nav__link">
<span class="md-ellipsis">
Module Generation Checklist
</span>
</a>
<nav class="md-nav" aria-label="Module Generation Checklist">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#phase-1-initial-generation" class="md-nav__link">
<span class="md-ellipsis">
Phase 1: Initial Generation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-2-validation" class="md-nav__link">
<span class="md-ellipsis">
Phase 2: Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-3-integration-validation" class="md-nav__link">
<span class="md-ellipsis">
Phase 3: Integration Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-4-pre-commit" class="md-nav__link">
<span class="md-ellipsis">
Phase 4: Pre-Commit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-5-git-commit" class="md-nav__link">
<span class="md-ellipsis">
Phase 5: Git Commit
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-validation-errors-and-fixes" class="md-nav__link">
<span class="md-ellipsis">
Common Validation Errors and Fixes
</span>
</a>
<nav class="md-nav" aria-label="Common Validation Errors and Fixes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#error-rpcd-script-name-doesnt-match-ubus-object" class="md-nav__link">
<span class="md-ellipsis">
Error: RPCD script name doesn't match ubus object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-menu-path-file-not-found" class="md-nav__link">
<span class="md-ellipsis">
Error: Menu path → file NOT FOUND
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-rpcd-script-is-not-executable" class="md-nav__link">
<span class="md-ellipsis">
Error: RPCD script is NOT executable
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-method-get_stats-from-rpcd-not-found-in-acl" class="md-nav__link">
<span class="md-ellipsis">
Error: Method 'get_stats' from RPCD not found in ACL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-invalid-json-syntax" class="md-nav__link">
<span class="md-ellipsis">
Error: Invalid JSON syntax
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#bypassing-validation-not-recommended" class="md-nav__link">
<span class="md-ellipsis">
Bypassing Validation (NOT RECOMMENDED)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#integration-with-cicd" class="md-nav__link">
<span class="md-ellipsis">
Integration with CI/CD
</span>
</a>
<nav class="md-nav" aria-label="Integration with CI/CD">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#github-actions" class="md-nav__link">
<span class="md-ellipsis">
GitHub Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#best-practices" class="md-nav__link">
<span class="md-ellipsis">
Best Practices
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
<nav class="md-nav" aria-label="Troubleshooting">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#validation-script-fails-to-run" class="md-nav__link">
<span class="md-ellipsis">
Validation script fails to run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#git-hook-not-running" class="md-nav__link">
<span class="md-ellipsis">
Git hook not running
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#false-positives-in-validation" class="md-nav__link">
<span class="md-ellipsis">
False positives in validation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#additional-resources" class="md-nav__link">
<span class="md-ellipsis">
Additional Resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support" class="md-nav__link">
<span class="md-ellipsis">
Support
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../permissions-guide/" class="md-nav__link">
<span class="md-ellipsis">
Permissions Guide
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../luci-development-reference/" class="md-nav__link">
<span class="md-ellipsis">
LuCI Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../codex/" class="md-nav__link">
<span class="md-ellipsis">
Codex Manual
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Modules
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Modules
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../module-status/" class="md-nav__link">
<span class="md-ellipsis">
Module Status
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../feature-regeneration-prompts/" class="md-nav__link">
<span class="md-ellipsis">
Feature Prompts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_6" >
<label class="md-nav__link" for="__nav_6" id="__nav_6_label" tabindex="0">
<span class="md-ellipsis">
Tools & Roadmap
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_6_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Tools & Roadmap
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../todo-analyse/" class="md-nav__link">
<span class="md-ellipsis">
TODO Roadmap
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_7" >
<label class="md-nav__link" for="__nav_7" id="__nav_7_label" tabindex="0">
<span class="md-ellipsis">
Archive
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_7_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Archive
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../archive/" class="md-nav__link">
<span class="md-ellipsis">
Archive Index
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/build-issues/" class="md-nav__link">
<span class="md-ellipsis">
Build Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/completion-report/" class="md-nav__link">
<span class="md-ellipsis">
Completion Report
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../archive/module-enable-disable-design/" class="md-nav__link">
<span class="md-ellipsis">
Module Enable/Disable
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#see-also" class="md-nav__link">
<span class="md-ellipsis">
See Also
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#overview" class="md-nav__link">
<span class="md-ellipsis">
Overview
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#validation-tools" class="md-nav__link">
<span class="md-ellipsis">
Validation Tools
</span>
</a>
<nav class="md-nav" aria-label="Validation Tools">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-validate-module-generationsh" class="md-nav__link">
<span class="md-ellipsis">
1. validate-module-generation.sh
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-pre-push-validationsh" class="md-nav__link">
<span class="md-ellipsis">
2. pre-push-validation.sh
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-validate-modulessh" class="md-nav__link">
<span class="md-ellipsis">
3. validate-modules.sh
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#installing-git-hooks" class="md-nav__link">
<span class="md-ellipsis">
Installing Git Hooks
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#critical-naming-conventions" class="md-nav__link">
<span class="md-ellipsis">
Critical Naming Conventions
</span>
</a>
<nav class="md-nav" aria-label="Critical Naming Conventions">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-rpcd-script-must-match-ubus-object" class="md-nav__link">
<span class="md-ellipsis">
1. RPCD Script MUST Match ubus Object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-menu-paths-must-match-view-file-locations" class="md-nav__link">
<span class="md-ellipsis">
2. Menu Paths MUST Match View File Locations
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-all-ubus-objects-must-use-luci-prefix" class="md-nav__link">
<span class="md-ellipsis">
3. All ubus Objects MUST Use luci. Prefix
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#module-generation-checklist" class="md-nav__link">
<span class="md-ellipsis">
Module Generation Checklist
</span>
</a>
<nav class="md-nav" aria-label="Module Generation Checklist">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#phase-1-initial-generation" class="md-nav__link">
<span class="md-ellipsis">
Phase 1: Initial Generation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-2-validation" class="md-nav__link">
<span class="md-ellipsis">
Phase 2: Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-3-integration-validation" class="md-nav__link">
<span class="md-ellipsis">
Phase 3: Integration Validation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-4-pre-commit" class="md-nav__link">
<span class="md-ellipsis">
Phase 4: Pre-Commit
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#phase-5-git-commit" class="md-nav__link">
<span class="md-ellipsis">
Phase 5: Git Commit
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-validation-errors-and-fixes" class="md-nav__link">
<span class="md-ellipsis">
Common Validation Errors and Fixes
</span>
</a>
<nav class="md-nav" aria-label="Common Validation Errors and Fixes">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#error-rpcd-script-name-doesnt-match-ubus-object" class="md-nav__link">
<span class="md-ellipsis">
Error: RPCD script name doesn't match ubus object
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-menu-path-file-not-found" class="md-nav__link">
<span class="md-ellipsis">
Error: Menu path → file NOT FOUND
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-rpcd-script-is-not-executable" class="md-nav__link">
<span class="md-ellipsis">
Error: RPCD script is NOT executable
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-method-get_stats-from-rpcd-not-found-in-acl" class="md-nav__link">
<span class="md-ellipsis">
Error: Method 'get_stats' from RPCD not found in ACL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#error-invalid-json-syntax" class="md-nav__link">
<span class="md-ellipsis">
Error: Invalid JSON syntax
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#bypassing-validation-not-recommended" class="md-nav__link">
<span class="md-ellipsis">
Bypassing Validation (NOT RECOMMENDED)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#integration-with-cicd" class="md-nav__link">
<span class="md-ellipsis">
Integration with CI/CD
</span>
</a>
<nav class="md-nav" aria-label="Integration with CI/CD">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#github-actions" class="md-nav__link">
<span class="md-ellipsis">
GitHub Actions
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#best-practices" class="md-nav__link">
<span class="md-ellipsis">
Best Practices
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
<nav class="md-nav" aria-label="Troubleshooting">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#validation-script-fails-to-run" class="md-nav__link">
<span class="md-ellipsis">
Validation script fails to run
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#git-hook-not-running" class="md-nav__link">
<span class="md-ellipsis">
Git hook not running
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#false-positives-in-validation" class="md-nav__link">
<span class="md-ellipsis">
False positives in validation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#additional-resources" class="md-nav__link">
<span class="md-ellipsis">
Additional Resources
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#support" class="md-nav__link">
<span class="md-ellipsis">
Support
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="secubox-module-validation-guide">SecuBox Module Validation Guide<a class="headerlink" href="#secubox-module-validation-guide" title="Permanent link">&para;</a></h1>
<p><strong>Version:</strong> 1.0.0<br />
<strong>Last Updated:</strong> 2025-12-28<br />
<strong>Status:</strong> Active</p>
<blockquote>
<p><strong>📚 Complete Reference:</strong>
This is a detailed validation guide. For quick commands, see <a href="../quick-start/">QUICK-START.md</a></p>
<p><strong>Related Documentation:</strong>
- Complete guide: <a href="../development-guidelines/#validation-checklist">DEVELOPMENT-GUIDELINES.md §8</a>
- Pre-commit checklist: <a href="../development-guidelines/#pre-commit-checklist">DEVELOPMENT-GUIDELINES.md §8.1</a>
- Post-deploy checklist: <a href="../development-guidelines/#post-deploy-checklist">DEVELOPMENT-GUIDELINES.md §8.3</a>
- Permissions guide: <a href="../permissions-guide/">PERMISSIONS-GUIDE.md</a>
- Automation briefing: <a href="../codex/">CODEX.md</a></p>
</blockquote>
<hr />
<h2 id="see-also">See Also<a class="headerlink" href="#see-also" title="Permanent link">&para;</a></h2>
<ul>
<li><strong>Quick Commands:</strong> <a href="../quick-start/">QUICK-START.md</a></li>
<li><strong>Permissions Reference:</strong> <a href="../permissions-guide/">PERMISSIONS-GUIDE.md</a></li>
<li><strong>Automation Guardrails:</strong> <a href="../codex/">CODEX.md</a></li>
<li><strong>Deployment Procedures:</strong> <a href="../development-guidelines/#deployment-procedures">DEVELOPMENT-GUIDELINES.md §9</a></li>
</ul>
<p>This guide explains the validation checks performed on SecuBox modules during generation and before git push.</p>
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">&para;</a></h2>
<p>SecuBox uses a multi-layered validation approach:</p>
<ol>
<li><strong>Module Generation Validation</strong> - Validates newly created/modified modules</li>
<li><strong>Pre-Push Validation</strong> - Blocks git push if critical issues are found</li>
<li><strong>Runtime Validation</strong> - Continuous checks on deployed modules</li>
</ol>
<h2 id="validation-tools">Validation Tools<a class="headerlink" href="#validation-tools" title="Permanent link">&para;</a></h2>
<h3 id="1-validate-module-generationsh">1. validate-module-generation.sh<a class="headerlink" href="#1-validate-module-generationsh" title="Permanent link">&para;</a></h3>
<p>Comprehensive validation for a single module during/after generation.</p>
<p><strong>Usage:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>./secubox-tools/validate-module-generation.sh<span class="w"> </span>luci-app-cdn-cache
</code></pre></div></p>
<p><strong>Checks performed:</strong>
- ✅ Makefile completeness and correctness
- ✅ RPCD script naming convention (must use <code>luci.</code> prefix)
- ✅ RPCD script executable permissions
- ✅ RPCD script structure (list/call handlers)
- ✅ ACL file JSON validity
- ✅ ACL permissions cover RPCD methods
- ✅ Menu file JSON validity
- ✅ Menu paths match view file locations
- ✅ JavaScript view files exist
- ✅ JavaScript strict mode usage
- ✅ RPC method calls match RPCD methods
- ✅ ubus object names match RPCD script names
- ✅ UCI config validity (if present)
- ✅ Security scan (hardcoded credentials, dangerous commands)
- ✅ Documentation presence</p>
<p><strong>Exit codes:</strong>
- <code>0</code> - All checks passed
- <code>1</code> - Critical errors found (module should not be deployed)</p>
<h3 id="2-pre-push-validationsh">2. pre-push-validation.sh<a class="headerlink" href="#2-pre-push-validationsh" title="Permanent link">&para;</a></h3>
<p>Validates all modules before allowing git push.</p>
<p><strong>Usage:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># Automatic (via git hook):</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a>git<span class="w"> </span>push<span class="w"> </span><span class="c1"># validation runs automatically</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a><span class="c1"># Manual:</span>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a>./secubox-tools/pre-push-validation.sh
</code></pre></div></p>
<p><strong>Checks performed:</strong>
- ✅ Git staged changes check
- ✅ RPCD naming conventions across all modules
- ✅ Menu path validation across all modules
- ✅ JSON syntax validation
- ✅ RPCD executable permissions
- ✅ ACL method coverage
- ✅ Makefile validation
- ✅ Security scans
- ✅ Full module validation on modified modules</p>
<p><strong>Exit codes:</strong>
- <code>0</code> - Push allowed
- <code>1</code> - Push blocked (critical errors)</p>
<h3 id="3-validate-modulessh">3. validate-modules.sh<a class="headerlink" href="#3-validate-modulessh" title="Permanent link">&para;</a></h3>
<p>Fast validation of all modules (existing tool).</p>
<p><strong>Usage:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>./secubox-tools/validate-modules.sh
</code></pre></div></p>
<p>See <code>secubox-tools/README.md</code> for details.</p>
<h2 id="installing-git-hooks">Installing Git Hooks<a class="headerlink" href="#installing-git-hooks" title="Permanent link">&para;</a></h2>
<p>To enable automatic validation before git push:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>./secubox-tools/install-git-hooks.sh
</code></pre></div>
<p>This creates a symbolic link from <code>.git/hooks/pre-push</code> to <code>secubox-tools/pre-push-validation.sh</code>.</p>
<h2 id="critical-naming-conventions">Critical Naming Conventions<a class="headerlink" href="#critical-naming-conventions" title="Permanent link">&para;</a></h2>
<h3 id="1-rpcd-script-must-match-ubus-object">1. RPCD Script MUST Match ubus Object<a class="headerlink" href="#1-rpcd-script-must-match-ubus-object" title="Permanent link">&para;</a></h3>
<p><strong>Rule:</strong> The RPCD script filename MUST exactly match the ubus object name declared in JavaScript.</p>
<p><strong>Why:</strong> LuCI's RPC system looks for RPCD scripts by their filename. If the name doesn't match, you get:
- <code>RPC call failed with error -32000: Object not found</code>
- <code>Command failed: Method not found</code></p>
<p><strong>Example:</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="c1">// JavaScript (htdocs/luci-static/resources/view/cdn-cache/overview.js)</span>
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="kd">var</span><span class="w"> </span><span class="nx">callStatus</span><span class="w"> </span><span class="o">=</span><span class="w"> </span><span class="nx">rpc</span><span class="p">.</span><span class="nx">declare</span><span class="p">({</span>
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a><span class="w"> </span><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.cdn-cache&#39;</span><span class="p">,</span><span class="w"> </span><span class="c1">// ← This must match RPCD filename</span>
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a><span class="w"> </span><span class="nx">method</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;status&#39;</span>
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a><span class="p">});</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># RPCD script filename MUST be:</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>root/usr/libexec/rpcd/luci.cdn-cache<span class="w"> </span><span class="c1"># ← Exactly &#39;luci.cdn-cache&#39;</span>
</code></pre></div>
<p><strong>Common mistakes:</strong>
- ❌ <code>root/usr/libexec/rpcd/cdn-cache</code> (missing <code>luci.</code> prefix)
- ❌ <code>root/usr/libexec/rpcd/luci-cdn-cache</code> (using dash instead of dot)
- ❌ <code>root/usr/libexec/rpcd/cdn_cache</code> (using underscore)</p>
<p><strong>Validation:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Check naming:</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>./secubox-tools/validate-module-generation.sh<span class="w"> </span>luci-app-cdn-cache
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="c1"># Look for:</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="c1"># ✓ RPCD script follows naming convention (luci.* prefix)</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="c1"># ✓ CRITICAL: RPCD script name matches ACL ubus object</span>
</code></pre></div></p>
<h3 id="2-menu-paths-must-match-view-file-locations">2. Menu Paths MUST Match View File Locations<a class="headerlink" href="#2-menu-paths-must-match-view-file-locations" title="Permanent link">&para;</a></h3>
<p><strong>Rule:</strong> Menu JSON <code>path</code> entries MUST correspond to actual view file paths.</p>
<p><strong>Why:</strong> LuCI loads views based on the path in the menu. Wrong path = HTTP 404.</p>
<p><strong>Example:</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1">// Menu (root/usr/share/luci/menu.d/luci-app-netifyd-dashboard.json)</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a><span class="p">{</span>
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a><span class="w"> </span><span class="nt">&quot;action&quot;</span><span class="p">:</span><span class="w"> </span><span class="p">{</span>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="w"> </span><span class="nt">&quot;type&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;view&quot;</span><span class="p">,</span>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a><span class="w"> </span><span class="nt">&quot;path&quot;</span><span class="p">:</span><span class="w"> </span><span class="s2">&quot;netifyd-dashboard/overview&quot;</span><span class="w"> </span><span class="c1">// ← Must match file location</span>
<a id="__codelineno-7-6" name="__codelineno-7-6" href="#__codelineno-7-6"></a><span class="w"> </span><span class="p">}</span>
<a id="__codelineno-7-7" name="__codelineno-7-7" href="#__codelineno-7-7"></a><span class="p">}</span>
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c1"># View file MUST exist at:</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>htdocs/luci-static/resources/view/netifyd-dashboard/overview.js
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a><span class="c1"># ↑ Same path as menu ↑</span>
</code></pre></div>
<p><strong>Common mistakes:</strong>
- ❌ Menu: <code>"path": "netifyd/overview"</code> but file at <code>view/netifyd-dashboard/overview.js</code>
- ❌ Menu: <code>"path": "overview"</code> but file at <code>view/netifyd-dashboard/overview.js</code></p>
<p><strong>Validation:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="c1"># Check paths:</span>
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>./secubox-tools/validate-module-generation.sh<span class="w"> </span>luci-app-netifyd-dashboard
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a>
<a id="__codelineno-9-4" name="__codelineno-9-4" href="#__codelineno-9-4"></a><span class="c1"># Look for:</span>
<a id="__codelineno-9-5" name="__codelineno-9-5" href="#__codelineno-9-5"></a><span class="c1"># ✓ Menu path &#39;netifyd-dashboard/overview&#39; → view file EXISTS</span>
</code></pre></div></p>
<h3 id="3-all-ubus-objects-must-use-luci-prefix">3. All ubus Objects MUST Use <code>luci.</code> Prefix<a class="headerlink" href="#3-all-ubus-objects-must-use-luci-prefix" title="Permanent link">&para;</a></h3>
<p><strong>Rule:</strong> Every ubus object declaration must start with <code>luci.</code></p>
<p><strong>Why:</strong> Consistent naming convention for LuCI applications. ACL system expects it.</p>
<p><strong>Example:</strong></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="c1">// ✅ Correct:</span>
<a id="__codelineno-10-2" name="__codelineno-10-2" href="#__codelineno-10-2"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.cdn-cache&#39;</span>
<a id="__codelineno-10-3" name="__codelineno-10-3" href="#__codelineno-10-3"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.system-hub&#39;</span>
<a id="__codelineno-10-4" name="__codelineno-10-4" href="#__codelineno-10-4"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;luci.wireguard-dashboard&#39;</span>
<a id="__codelineno-10-5" name="__codelineno-10-5" href="#__codelineno-10-5"></a>
<a id="__codelineno-10-6" name="__codelineno-10-6" href="#__codelineno-10-6"></a><span class="c1">// ❌ Wrong:</span>
<a id="__codelineno-10-7" name="__codelineno-10-7" href="#__codelineno-10-7"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;cdn-cache&#39;</span><span class="w"> </span><span class="c1">// Missing luci. prefix</span>
<a id="__codelineno-10-8" name="__codelineno-10-8" href="#__codelineno-10-8"></a><span class="nx">object</span><span class="o">:</span><span class="w"> </span><span class="s1">&#39;systemhub&#39;</span><span class="w"> </span><span class="c1">// Missing luci. prefix</span>
</code></pre></div>
<p><strong>Validation:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a><span class="c1"># Check convention:</span>
<a id="__codelineno-11-2" name="__codelineno-11-2" href="#__codelineno-11-2"></a>./secubox-tools/validate-modules.sh
<a id="__codelineno-11-3" name="__codelineno-11-3" href="#__codelineno-11-3"></a>
<a id="__codelineno-11-4" name="__codelineno-11-4" href="#__codelineno-11-4"></a><span class="c1"># Look for:</span>
<a id="__codelineno-11-5" name="__codelineno-11-5" href="#__codelineno-11-5"></a><span class="c1"># ✓ ubus object &#39;luci.cdn-cache&#39; follows naming convention</span>
</code></pre></div></p>
<h2 id="module-generation-checklist">Module Generation Checklist<a class="headerlink" href="#module-generation-checklist" title="Permanent link">&para;</a></h2>
<p>Use this checklist when generating a new module:</p>
<h3 id="phase-1-initial-generation">Phase 1: Initial Generation<a class="headerlink" href="#phase-1-initial-generation" title="Permanent link">&para;</a></h3>
<ul class="task-list">
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Create module directory: <code>luci-app-&lt;module-name&gt;/</code></li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Generate Makefile with all required fields</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Create RPCD script at <code>root/usr/libexec/rpcd/luci.&lt;module-name&gt;</code></li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Make RPCD script executable: <code>chmod +x</code></li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Add shebang to RPCD: <code>#!/bin/sh</code></li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Implement RPCD methods (list, call, status, etc.)</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Create ACL file with read/write permissions</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Create menu JSON with correct paths</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Create view JavaScript files</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Add <code>'use strict';</code> to all JS files</li>
</ul>
<h3 id="phase-2-validation">Phase 2: Validation<a class="headerlink" href="#phase-2-validation" title="Permanent link">&para;</a></h3>
<ul class="task-list">
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Run module generation validation:
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>./secubox-tools/validate-module-generation.sh<span class="w"> </span>luci-app-&lt;module-name&gt;
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Fix all ERRORS (critical)</p>
</li>
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Review all WARNINGS (recommended)</li>
</ul>
<h3 id="phase-3-integration-validation">Phase 3: Integration Validation<a class="headerlink" href="#phase-3-integration-validation" title="Permanent link">&para;</a></h3>
<ul class="task-list">
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Verify RPCD script name matches ubus object:
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>grep<span class="w"> </span>-r<span class="w"> </span><span class="s2">&quot;object:&quot;</span><span class="w"> </span>luci-app-&lt;module-name&gt;/htdocs<span class="w"> </span>--include<span class="o">=</span><span class="s2">&quot;*.js&quot;</span>
<a id="__codelineno-13-2" name="__codelineno-13-2" href="#__codelineno-13-2"></a>ls<span class="w"> </span>-la<span class="w"> </span>luci-app-&lt;module-name&gt;/root/usr/libexec/rpcd/
<a id="__codelineno-13-3" name="__codelineno-13-3" href="#__codelineno-13-3"></a><span class="c1"># Names must match exactly</span>
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Verify menu paths match view files:
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>grep<span class="w"> </span><span class="s1">&#39;&quot;path&quot;:&#39;</span><span class="w"> </span>luci-app-&lt;module-name&gt;/root/usr/share/luci/menu.d/*.json
<a id="__codelineno-14-2" name="__codelineno-14-2" href="#__codelineno-14-2"></a>ls<span class="w"> </span>-R<span class="w"> </span>luci-app-&lt;module-name&gt;/htdocs/luci-static/resources/view/
<a id="__codelineno-14-3" name="__codelineno-14-3" href="#__codelineno-14-3"></a><span class="c1"># Paths must align</span>
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Verify ACL permissions cover all RPCD methods:
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a>grep<span class="w"> </span><span class="s1">&#39;case &quot;$2&quot;&#39;</span><span class="w"> </span>luci-app-&lt;module-name&gt;/root/usr/libexec/rpcd/*
<a id="__codelineno-15-2" name="__codelineno-15-2" href="#__codelineno-15-2"></a>grep<span class="w"> </span>-A<span class="w"> </span><span class="m">20</span><span class="w"> </span><span class="s1">&#39;&quot;ubus&quot;:&#39;</span><span class="w"> </span>luci-app-&lt;module-name&gt;/root/usr/share/rpcd/acl.d/*.json
<a id="__codelineno-15-3" name="__codelineno-15-3" href="#__codelineno-15-3"></a><span class="c1"># All methods should be in ACL</span>
</code></pre></div></p>
</li>
</ul>
<h3 id="phase-4-pre-commit">Phase 4: Pre-Commit<a class="headerlink" href="#phase-4-pre-commit" title="Permanent link">&para;</a></h3>
<ul class="task-list">
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Run comprehensive validation:
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a>./secubox-tools/validate-modules.sh
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Review security scan results</p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Check JSON validity:
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a>find<span class="w"> </span>luci-app-&lt;module-name&gt;<span class="w"> </span>-name<span class="w"> </span><span class="s2">&quot;*.json&quot;</span><span class="w"> </span>-exec<span class="w"> </span>python3<span class="w"> </span>-m<span class="w"> </span>json.tool<span class="w"> </span><span class="o">{}</span><span class="w"> </span><span class="se">\;</span><span class="w"> </span>&gt;<span class="w"> </span>/dev/null
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Optional: Run shellcheck on RPCD:
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a>shellcheck<span class="w"> </span>luci-app-&lt;module-name&gt;/root/usr/libexec/rpcd/*
</code></pre></div></p>
</li>
</ul>
<h3 id="phase-5-git-commit">Phase 5: Git Commit<a class="headerlink" href="#phase-5-git-commit" title="Permanent link">&para;</a></h3>
<ul class="task-list">
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Stage changes:
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a>git<span class="w"> </span>add<span class="w"> </span>luci-app-&lt;module-name&gt;
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Commit with descriptive message:
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a>git<span class="w"> </span>commit<span class="w"> </span>-m<span class="w"> </span><span class="s2">&quot;feat: implement &lt;module-name&gt; module</span>
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a><span class="s2">- Add RPCD backend with methods: status, get_*, set_*</span>
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="s2">- Create views for overview, settings, etc.</span>
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a><span class="s2">- Configure ACL permissions</span>
<a id="__codelineno-20-6" name="__codelineno-20-6" href="#__codelineno-20-6"></a><span class="s2">- Add menu entries</span>
<a id="__codelineno-20-7" name="__codelineno-20-7" href="#__codelineno-20-7"></a>
<a id="__codelineno-20-8" name="__codelineno-20-8" href="#__codelineno-20-8"></a><span class="s2">🤖 Generated with [Claude Code](https://claude.com/claude-code)</span>
<a id="__codelineno-20-9" name="__codelineno-20-9" href="#__codelineno-20-9"></a>
<a id="__codelineno-20-10" name="__codelineno-20-10" href="#__codelineno-20-10"></a><span class="s2">Co-Authored-By: Claude Sonnet 4.5 &lt;noreply@anthropic.com&gt;&quot;</span>
</code></pre></div></p>
</li>
<li class="task-list-item">
<p><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Push (validation runs automatically):
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a>git<span class="w"> </span>push
</code></pre></div></p>
</li>
</ul>
<h2 id="common-validation-errors-and-fixes">Common Validation Errors and Fixes<a class="headerlink" href="#common-validation-errors-and-fixes" title="Permanent link">&para;</a></h2>
<h3 id="error-rpcd-script-name-doesnt-match-ubus-object">Error: RPCD script name doesn't match ubus object<a class="headerlink" href="#error-rpcd-script-name-doesnt-match-ubus-object" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>✗ ERROR: luci-app-cdn-cache: RPCD script &#39;cdn-cache&#39; does NOT match ubus object &#39;luci.cdn-cache&#39;
</code></pre></div>
<p><strong>Fix:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a><span class="nb">cd</span><span class="w"> </span>luci-app-cdn-cache/root/usr/libexec/rpcd
<a id="__codelineno-23-2" name="__codelineno-23-2" href="#__codelineno-23-2"></a>mv<span class="w"> </span>cdn-cache<span class="w"> </span>luci.cdn-cache
</code></pre></div></p>
<h3 id="error-menu-path-file-not-found">Error: Menu path → file NOT FOUND<a class="headerlink" href="#error-menu-path-file-not-found" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>✗ ERROR: luci-app-netifyd: Menu path &#39;netifyd/overview&#39; → file NOT FOUND
<a id="__codelineno-24-2" name="__codelineno-24-2" href="#__codelineno-24-2"></a>Expected: htdocs/luci-static/resources/view/netifyd/overview.js
</code></pre></div>
<p><strong>Fix Option 1:</strong> Update menu path to match file:
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a><span class="c1"># Edit root/usr/share/luci/menu.d/luci-app-netifyd-dashboard.json</span>
<a id="__codelineno-25-2" name="__codelineno-25-2" href="#__codelineno-25-2"></a><span class="c1"># Change: &quot;path&quot;: &quot;netifyd/overview&quot;</span>
<a id="__codelineno-25-3" name="__codelineno-25-3" href="#__codelineno-25-3"></a><span class="c1"># To: &quot;path&quot;: &quot;netifyd-dashboard/overview&quot;</span>
</code></pre></div></p>
<p><strong>Fix Option 2:</strong> Move view file to match menu:
<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a>mv<span class="w"> </span>htdocs/luci-static/resources/view/netifyd-dashboard<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a><span class="w"> </span>htdocs/luci-static/resources/view/netifyd
</code></pre></div></p>
<h3 id="error-rpcd-script-is-not-executable">Error: RPCD script is NOT executable<a class="headerlink" href="#error-rpcd-script-is-not-executable" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a>✗ ERROR: luci-app-cdn-cache: luci.cdn-cache is NOT executable
</code></pre></div>
<p><strong>Fix:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a>chmod<span class="w"> </span>+x<span class="w"> </span>luci-app-cdn-cache/root/usr/libexec/rpcd/luci.cdn-cache
</code></pre></div></p>
<h3 id="error-method-get_stats-from-rpcd-not-found-in-acl">Error: Method 'get_stats' from RPCD not found in ACL<a class="headerlink" href="#error-method-get_stats-from-rpcd-not-found-in-acl" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>⚠ WARNING: luci-app-cdn-cache: Method &#39;get_stats&#39; from RPCD not in ACL
</code></pre></div>
<p><strong>Fix:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="c1"># Edit root/usr/share/rpcd/acl.d/luci-app-cdn-cache.json</span>
<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="c1"># Add &#39;get_stats&#39; to the read.ubus array:</span>
<a id="__codelineno-30-3" name="__codelineno-30-3" href="#__codelineno-30-3"></a><span class="o">{</span>
<a id="__codelineno-30-4" name="__codelineno-30-4" href="#__codelineno-30-4"></a><span class="w"> </span><span class="s2">&quot;luci-app-cdn-cache&quot;</span>:<span class="w"> </span><span class="o">{</span>
<a id="__codelineno-30-5" name="__codelineno-30-5" href="#__codelineno-30-5"></a><span class="w"> </span><span class="s2">&quot;read&quot;</span>:<span class="w"> </span><span class="o">{</span>
<a id="__codelineno-30-6" name="__codelineno-30-6" href="#__codelineno-30-6"></a><span class="w"> </span><span class="s2">&quot;ubus&quot;</span>:<span class="w"> </span><span class="o">{</span>
<a id="__codelineno-30-7" name="__codelineno-30-7" href="#__codelineno-30-7"></a><span class="w"> </span><span class="s2">&quot;luci.cdn-cache&quot;</span>:<span class="w"> </span><span class="o">[</span><span class="s2">&quot;status&quot;</span>,<span class="w"> </span><span class="s2">&quot;get_config&quot;</span>,<span class="w"> </span><span class="s2">&quot;get_stats&quot;</span><span class="o">]</span>
<a id="__codelineno-30-8" name="__codelineno-30-8" href="#__codelineno-30-8"></a><span class="w"> </span>↑<span class="w"> </span>Add<span class="w"> </span>here
<a id="__codelineno-30-9" name="__codelineno-30-9" href="#__codelineno-30-9"></a><span class="w"> </span><span class="o">}</span>
<a id="__codelineno-30-10" name="__codelineno-30-10" href="#__codelineno-30-10"></a><span class="w"> </span><span class="o">}</span>
<a id="__codelineno-30-11" name="__codelineno-30-11" href="#__codelineno-30-11"></a><span class="w"> </span><span class="o">}</span>
<a id="__codelineno-30-12" name="__codelineno-30-12" href="#__codelineno-30-12"></a><span class="o">}</span>
</code></pre></div></p>
<h3 id="error-invalid-json-syntax">Error: Invalid JSON syntax<a class="headerlink" href="#error-invalid-json-syntax" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a>✗ ERROR: luci-app-cdn-cache: acl.d JSON is INVALID - syntax error
</code></pre></div>
<p><strong>Fix:</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-32-1" name="__codelineno-32-1" href="#__codelineno-32-1"></a><span class="c1"># Validate JSON:</span>
<a id="__codelineno-32-2" name="__codelineno-32-2" href="#__codelineno-32-2"></a>python3<span class="w"> </span>-m<span class="w"> </span>json.tool<span class="w"> </span>root/usr/share/rpcd/acl.d/luci-app-cdn-cache.json
<a id="__codelineno-32-3" name="__codelineno-32-3" href="#__codelineno-32-3"></a>
<a id="__codelineno-32-4" name="__codelineno-32-4" href="#__codelineno-32-4"></a><span class="c1"># Common issues:</span>
<a id="__codelineno-32-5" name="__codelineno-32-5" href="#__codelineno-32-5"></a><span class="c1"># - Missing comma between array elements</span>
<a id="__codelineno-32-6" name="__codelineno-32-6" href="#__codelineno-32-6"></a><span class="c1"># - Trailing comma after last element</span>
<a id="__codelineno-32-7" name="__codelineno-32-7" href="#__codelineno-32-7"></a><span class="c1"># - Unescaped quotes in strings</span>
</code></pre></div></p>
<h2 id="bypassing-validation-not-recommended">Bypassing Validation (NOT RECOMMENDED)<a class="headerlink" href="#bypassing-validation-not-recommended" title="Permanent link">&para;</a></h2>
<p>In rare cases, you may need to bypass validation:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-33-1" name="__codelineno-33-1" href="#__codelineno-33-1"></a><span class="c1"># Skip pre-push validation:</span>
<a id="__codelineno-33-2" name="__codelineno-33-2" href="#__codelineno-33-2"></a>git<span class="w"> </span>push<span class="w"> </span>--no-verify
<a id="__codelineno-33-3" name="__codelineno-33-3" href="#__codelineno-33-3"></a>
<a id="__codelineno-33-4" name="__codelineno-33-4" href="#__codelineno-33-4"></a><span class="c1"># Skip module generation validation:</span>
<a id="__codelineno-33-5" name="__codelineno-33-5" href="#__codelineno-33-5"></a><span class="c1"># (can&#39;t bypass - it&#39;s informational only)</span>
</code></pre></div>
<p><strong>⚠️ WARNING:</strong> Bypassing validation can lead to broken modules in production!</p>
<h2 id="integration-with-cicd">Integration with CI/CD<a class="headerlink" href="#integration-with-cicd" title="Permanent link">&para;</a></h2>
<h3 id="github-actions">GitHub Actions<a class="headerlink" href="#github-actions" title="Permanent link">&para;</a></h3>
<p>Add validation to your workflow:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-34-1" name="__codelineno-34-1" href="#__codelineno-34-1"></a><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Validate Modules</span>
<a id="__codelineno-34-2" name="__codelineno-34-2" href="#__codelineno-34-2"></a>
<a id="__codelineno-34-3" name="__codelineno-34-3" href="#__codelineno-34-3"></a><span class="nt">on</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">[</span><span class="nv">push</span><span class="p p-Indicator">,</span><span class="w"> </span><span class="nv">pull_request</span><span class="p p-Indicator">]</span>
<a id="__codelineno-34-4" name="__codelineno-34-4" href="#__codelineno-34-4"></a>
<a id="__codelineno-34-5" name="__codelineno-34-5" href="#__codelineno-34-5"></a><span class="nt">jobs</span><span class="p">:</span>
<a id="__codelineno-34-6" name="__codelineno-34-6" href="#__codelineno-34-6"></a><span class="w"> </span><span class="nt">validate</span><span class="p">:</span>
<a id="__codelineno-34-7" name="__codelineno-34-7" href="#__codelineno-34-7"></a><span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-latest</span>
<a id="__codelineno-34-8" name="__codelineno-34-8" href="#__codelineno-34-8"></a>
<a id="__codelineno-34-9" name="__codelineno-34-9" href="#__codelineno-34-9"></a><span class="w"> </span><span class="nt">steps</span><span class="p">:</span>
<a id="__codelineno-34-10" name="__codelineno-34-10" href="#__codelineno-34-10"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">actions/checkout@v4</span>
<a id="__codelineno-34-11" name="__codelineno-34-11" href="#__codelineno-34-11"></a>
<a id="__codelineno-34-12" name="__codelineno-34-12" href="#__codelineno-34-12"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Install dependencies</span>
<a id="__codelineno-34-13" name="__codelineno-34-13" href="#__codelineno-34-13"></a><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
<a id="__codelineno-34-14" name="__codelineno-34-14" href="#__codelineno-34-14"></a><span class="w"> </span><span class="no">sudo apt-get update</span>
<a id="__codelineno-34-15" name="__codelineno-34-15" href="#__codelineno-34-15"></a><span class="w"> </span><span class="no">sudo apt-get install -y python3 shellcheck</span>
<a id="__codelineno-34-16" name="__codelineno-34-16" href="#__codelineno-34-16"></a>
<a id="__codelineno-34-17" name="__codelineno-34-17" href="#__codelineno-34-17"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run module validation</span>
<a id="__codelineno-34-18" name="__codelineno-34-18" href="#__codelineno-34-18"></a><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
<a id="__codelineno-34-19" name="__codelineno-34-19" href="#__codelineno-34-19"></a><span class="w"> </span><span class="no">chmod +x secubox-tools/validate-modules.sh</span>
<a id="__codelineno-34-20" name="__codelineno-34-20" href="#__codelineno-34-20"></a><span class="w"> </span><span class="no">./secubox-tools/validate-modules.sh</span>
<a id="__codelineno-34-21" name="__codelineno-34-21" href="#__codelineno-34-21"></a>
<a id="__codelineno-34-22" name="__codelineno-34-22" href="#__codelineno-34-22"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Run pre-push validation</span>
<a id="__codelineno-34-23" name="__codelineno-34-23" href="#__codelineno-34-23"></a><span class="w"> </span><span class="nt">run</span><span class="p">:</span><span class="w"> </span><span class="p p-Indicator">|</span>
<a id="__codelineno-34-24" name="__codelineno-34-24" href="#__codelineno-34-24"></a><span class="w"> </span><span class="no">chmod +x secubox-tools/pre-push-validation.sh</span>
<a id="__codelineno-34-25" name="__codelineno-34-25" href="#__codelineno-34-25"></a><span class="w"> </span><span class="no">./secubox-tools/pre-push-validation.sh</span>
</code></pre></div>
<h2 id="best-practices">Best Practices<a class="headerlink" href="#best-practices" title="Permanent link">&para;</a></h2>
<ol>
<li>
<p><strong>Always validate before committing</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-35-1" name="__codelineno-35-1" href="#__codelineno-35-1"></a>./secubox-tools/validate-module-generation.sh<span class="w"> </span>luci-app-&lt;module&gt;
</code></pre></div></p>
</li>
<li>
<p><strong>Install git hooks for automatic validation</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-36-1" name="__codelineno-36-1" href="#__codelineno-36-1"></a>./secubox-tools/install-git-hooks.sh
</code></pre></div></p>
</li>
<li>
<p><strong>Fix errors immediately</strong> - Don't accumulate validation debt</p>
</li>
<li>
<p><strong>Review warnings</strong> - They often indicate real issues</p>
</li>
<li>
<p><strong>Test on OpenWrt</strong> before marking complete:
<div class="highlight"><pre><span></span><code><a id="__codelineno-37-1" name="__codelineno-37-1" href="#__codelineno-37-1"></a>scp<span class="w"> </span>bin/packages/*/base/luci-app-*.ipk<span class="w"> </span>root@192.168.1.1:/tmp/
<a id="__codelineno-37-2" name="__codelineno-37-2" href="#__codelineno-37-2"></a>ssh<span class="w"> </span>root@192.168.1.1
<a id="__codelineno-37-3" name="__codelineno-37-3" href="#__codelineno-37-3"></a>opkg<span class="w"> </span>install<span class="w"> </span>/tmp/luci-app-*.ipk
<a id="__codelineno-37-4" name="__codelineno-37-4" href="#__codelineno-37-4"></a>/etc/init.d/rpcd<span class="w"> </span>restart
<a id="__codelineno-37-5" name="__codelineno-37-5" href="#__codelineno-37-5"></a>/etc/init.d/uhttpd<span class="w"> </span>restart
</code></pre></div></p>
</li>
<li>
<p><strong>Document module-specific requirements</strong> in module README</p>
</li>
</ol>
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
<h3 id="validation-script-fails-to-run">Validation script fails to run<a class="headerlink" href="#validation-script-fails-to-run" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-38-1" name="__codelineno-38-1" href="#__codelineno-38-1"></a><span class="c1"># Make sure scripts are executable:</span>
<a id="__codelineno-38-2" name="__codelineno-38-2" href="#__codelineno-38-2"></a>chmod<span class="w"> </span>+x<span class="w"> </span>secubox-tools/*.sh
<a id="__codelineno-38-3" name="__codelineno-38-3" href="#__codelineno-38-3"></a>
<a id="__codelineno-38-4" name="__codelineno-38-4" href="#__codelineno-38-4"></a><span class="c1"># Check dependencies:</span>
<a id="__codelineno-38-5" name="__codelineno-38-5" href="#__codelineno-38-5"></a>which<span class="w"> </span>python3<span class="w"> </span><span class="c1"># For JSON validation</span>
<a id="__codelineno-38-6" name="__codelineno-38-6" href="#__codelineno-38-6"></a>which<span class="w"> </span>shellcheck<span class="w"> </span><span class="c1"># For shell script validation</span>
</code></pre></div>
<h3 id="git-hook-not-running">Git hook not running<a class="headerlink" href="#git-hook-not-running" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-39-1" name="__codelineno-39-1" href="#__codelineno-39-1"></a><span class="c1"># Check hook is installed:</span>
<a id="__codelineno-39-2" name="__codelineno-39-2" href="#__codelineno-39-2"></a>ls<span class="w"> </span>-la<span class="w"> </span>.git/hooks/pre-push
<a id="__codelineno-39-3" name="__codelineno-39-3" href="#__codelineno-39-3"></a>
<a id="__codelineno-39-4" name="__codelineno-39-4" href="#__codelineno-39-4"></a><span class="c1"># Reinstall hooks:</span>
<a id="__codelineno-39-5" name="__codelineno-39-5" href="#__codelineno-39-5"></a>./secubox-tools/install-git-hooks.sh
</code></pre></div>
<h3 id="false-positives-in-validation">False positives in validation<a class="headerlink" href="#false-positives-in-validation" title="Permanent link">&para;</a></h3>
<p>If validation incorrectly reports an error, please report it:
- Create issue with full validation output
- Include module name and specific check that failed
- We'll update validation logic</p>
<h2 id="additional-resources">Additional Resources<a class="headerlink" href="#additional-resources" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="../claude/">CLAUDE.md</a> - Main project documentation</li>
<li><a href="https://github.com/CyberMind-FR/secubox-openwrt/blob/master/secubox-tools/README.md">secubox-tools/README.md</a> - Tools documentation</li>
<li><a href="../feature-regeneration-prompts/">Feature Regeneration Prompts</a> - Module generation prompts</li>
</ul>
<h2 id="support">Support<a class="headerlink" href="#support" title="Permanent link">&para;</a></h2>
<p>If you encounter validation issues:</p>
<ol>
<li>Check this guide for common errors</li>
<li>Run validation with verbose output</li>
<li>Review CLAUDE.md for naming conventions</li>
<li>Create issue on GitHub with validation output</li>
</ol>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/CyberMind-FR/secubox-openwrt" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://secubox.cybermood.eu" target="_blank" rel="noopener" title="secubox.cybermood.eu" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M351.9 280H161c2.9 64.5 17.2 123.9 37.5 167.4 11.4 24.5 23.7 41.8 35.1 52.4 11.2 10.5 18.9 12.2 22.9 12.2s11.7-1.7 22.9-12.2c11.4-10.6 23.7-28 35.1-52.4 20.3-43.5 34.6-102.9 37.5-167.4zm-191-48h190.9c-2.8-64.5-17.1-123.9-37.4-167.4-11.4-24.4-23.7-41.8-35.1-52.4C268.1 1.7 260.4 0 256.4 0s-11.7 1.7-22.9 12.2c-11.4 10.6-23.7 28-35.1 52.4-20.3 43.5-34.6 102.9-37.5 167.4m-48 0c3.5-85.6 25.6-165.1 57.9-217.3C78.7 47.3 10.9 131.2 1.5 232zM1.5 280c9.4 100.8 77.2 184.7 169.3 217.3-32.3-52.2-54.4-131.7-57.9-217.3zm398.4 0c-3.5 85.6-25.6 165.1-57.9 217.3 92.1-32.7 159.9-116.5 169.3-217.3zm111.4-48C501.9 131.2 434.1 47.3 342 14.7c32.3 52.2 54.4 131.7 57.9 217.3z"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"annotate": null, "base": "..", "features": ["navigation.instant", "navigation.tracking", "navigation.tabs", "navigation.tabs.sticky", "navigation.sections", "navigation.expand", "navigation.top", "search.suggest", "search.highlight", "content.code.copy", "content.code.annotate"], "search": "../assets/javascripts/workers/search.2c215733.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": {"provider": "mike"}}</script>
<script src="../assets/javascripts/bundle.79ae519e.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink