Skip to content

Generate database passwords with random_password / Keep the database helpers' credentials files private - #242

Merged
michelroegl-brunner merged 2 commits into
mainfrom
fix/db-helper-passwords
Nov 12, 2026
Merged

michelroegl-brunner merged 2 commits into
mainfrom
fix/db-helper-passwords

Conversation

@MickLesk

Copy link
Copy Markdown
Member

✍️ Description

setup_postgresql_db, setup_mariadb_db and setup_mysql_db wrote the database password to ~/.creds with the default umask, so the file was world-readable (644). It is chmod 600 now.

setup_postgresql_db, setup_mariadb_db, setup_mysql_db and prompt_password built passwords with openssl rand | tr | head. They use random_password now.

🔗 Related Issue

Fixes #

✅ Prerequisites (X in brackets)

  • Self-review completed – Code follows project standards.
  • Tested thoroughly – Changes work as expected (Proxmox VE and/or Incus, as applicable).
  • No security risks – No hardcoded secrets, unnecessary privilege escalations, or permission issues.
  • API.txt regenerated – If a function signature or behavior changed, API.txt was updated to match.

🛠️ Type of Change (X in brackets)

  • 🐞 Bug fix – Resolves an issue without breaking functionality.
  • ✨ New feature – Adds new, non-breaking functionality.
  • 💥 Breaking change – Alters existing behavior in a way that may require updates in every downstream script.
  • 🔧 Refactoring / Code Cleanup – Improves readability or maintainability without changing functionality.
  • 📝 Documentation update – Changes to README, docs/, CONTRIBUTING.md, or other docs.

🤖 AI Assistance (X in brackets)

If you used an AI tool (GitHub Copilot, Claude, ChatGPT, etc.) to write or generate any code in this PR, you must confirm compliance below.
Select exactly one option.

  • No AI used – Code was written without AI assistance.
  • AI was used – The output has been reviewed and corrected, and I take responsibility for it matching this repo's conventions.

setup_postgresql_db, setup_mariadb_db, setup_mysql_db and prompt_password
built passwords with openssl rand | tr | head, the pattern AGENTS.md
forbids. They use random_password now.

The three database helpers also read APPLICATION under set -u, which only
an install script has. An addon (pgAdmin) calling setup_postgresql_db died
with "APPLICATION: unbound variable"; the credentials file name now falls
back to APP.
setup_postgresql_db, setup_mariadb_db and setup_mysql_db wrote the
database password to ~/<app>.creds with the default umask, so the file was
world-readable (644). It is chmod 600 now.
@github-actions

Copy link
Copy Markdown
Contributor

Try this branch

The engine and the scripts resolve independently, so a production script can
be run against the engine from this PR by setting one variable:

COMMUNITY_SCRIPTS_CORE_URL=https://raw.githubusercontent.com/community-scripts/core/fix/db-helper-passwords \
bash -c "$(curl -fsSL https://raw.githubusercontent.com/community-scripts/ProxmoxVE/main/ct/debian.sh)"

Swap ct/debian.sh for whatever exercises the change.

Run a script from a fork as well
curl -fsSL https://raw.githubusercontent.com/community-scripts/core/fix/db-helper-passwords/tools/run.sh |
  bash -s -- https://raw.githubusercontent.com/YOU/DevScripts/your-branch ct/debian.sh \
             https://raw.githubusercontent.com/community-scripts/core/fix/db-helper-passwords

Note that run.sh is reached through a pipe, so the script it starts inherits
an exhausted stdin. Whiptail is fine — it opens /dev/tty — but a plain read
would see EOF. The single-variable form above does not have that problem.

Useful flags while testing

dev_mode=net logs every engine fetch with status and duration, which is the
quickest way to confirm the branch is really being used. dev_mode=keep stops a
failed build from deleting the container along with the evidence.

@michelroegl-brunner
michelroegl-brunner merged commit 07e8438 into main Nov 12, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants