The secret check before an extension is packaged
This page is for designers whose theme export was refused with a list of findings. Since Exponential 6.0.15 no
package takes an extension that holds secret values or key material: Setup > Extensions, the package wizard and
ezpm.php add all ask the same check (eZExtensionPackageHandler::packRefusal()). The page names the file and the
setting or kind of secret, never the value.
What is refused
| Finding | Meaning |
|---|---|
<file>: <Setting> | A setting whose name marks a secret (Password, ApiKey, ClientSecret, Token ...) has a value, or another setting carries a password inside an address |
<file>: (private key) | A private key block in any file. Always refused |
<file>: (bearer token), (API key), (constant), (address with a password) | The shape of a secret in any text |
<file>: key material | A key file by its name: *.key, *.p12, .env, id_rsa, credentials* and others. Always refused |
<file>: copy of a settings file | A backup such as *.bak, *.orig, *~. Always refused: delete the copy |
Settings files are read as text, commented lines included. A node_modules directory is neither packed nor read.
Step by step: a real finding
- Read the finding: file and setting.
- Remove the value from the theme. A theme never needs a real password or key; the installation supplies them in
its own
settings/override/. - If the value was ever committed and pushed, consider it public: have it changed where it is used.
- Document in the README which setting the installation must fill.
- Export again.
Step by step: an example the check cannot tell apart
A documentation comment with a key-shaped example value, for instance:
Create
package_check.iniat the root of the theme:[PackageCheck] # The example key in the documentation comment AllowedFindings[]=settings/mytheme.ini.append.php:ApiKeyOne finding per line, written as the refusal names it:
<path below the extension>:<setting name or (kind)>. A path ending in/covers that directory.Export again.
It only leaves out what it names. Key files, a private key block, a copy of a settings file and a link are always
refused. Placeholders (..., <your key>, %password%, enabled, none) pass without any entry. An active setting
is taken at its word: Password=changeme is refused.
Related pages
- The secret check of extension packages
- A .gitignore for themes
- Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.
Become an Exponential Partner
Partners share their information, provide funding, contribute back and develop the products with us, and that is how Exponential grows. A partner website and dashboard are planned for mid-2027: please become a partner today to speed up our growth rate and land new features faster.