DOC: config: recommend single quoting passwords

Suggests single quoting passwords and update examples to avoid unexpected
behaviors due to special characters.

Should be backported to stable versions.

Link: https://discourse.haproxy.org/t/enhance-documentation-for-insecure-passwords-and-invald-characters/11959
This commit is contained in:
Lukas Tribus 2025-08-12 16:28:55 +00:00 committed by William Lallemand
parent faacc6c084
commit 9432e7d688

View File

@ -12142,9 +12142,9 @@ stats admin { if | unless } <cond>
# statistics admin level depends on the authenticated user # statistics admin level depends on the authenticated user
userlist stats-auth userlist stats-auth
group admin users admin group admin users admin
user admin insecure-password AdMiN123 user admin insecure-password 'AdMiN123'
group readonly users haproxy group readonly users haproxy
user haproxy insecure-password haproxy user haproxy insecure-password 'haproxy'
backend stats_auth backend stats_auth
stats enable stats enable
@ -29799,22 +29799,26 @@ user <username> [password|insecure-password <password>]
slower than their glibc counterparts when calculating hashes, so you might slower than their glibc counterparts when calculating hashes, so you might
want to consider this aspect too. want to consider this aspect too.
All passwords are considered normal arguments and are therefor subject to
regular section 2.2 Quoting and escaping. Single quoting passwords is
therefor recommended.
Example: Example:
userlist L1 userlist L1
group G1 users tiger,scott group G1 users tiger,scott
group G2 users xdb,scott group G2 users xdb,scott
user tiger password $6$k6y3o.eP$JlKBx9za9667qe4(...)xHSwRv6J.C0/D7cV91 user tiger password $6$k6y3o.eP$JlKBx9za9667qe4(...)xHSwRv6J.C0/D7cV91
user scott insecure-password elgato user scott insecure-password 'elgato'
user xdb insecure-password hello user xdb insecure-password 'hello'
userlist L2 userlist L2
group G1 group G1
group G2 group G2
user tiger password $6$k6y3o.eP$JlKBx(...)xHSwRv6J.C0/D7cV91 groups G1 user tiger password $6$k6y3o.eP$JlKBx(...)xHSwRv6J.C0/D7cV91 groups G1
user scott insecure-password elgato groups G1,G2 user scott insecure-password 'elgato' groups G1,G2
user xdb insecure-password hello groups G2 user xdb insecure-password 'hello' groups G2
Please note that both lists are functionally identical. Please note that both lists are functionally identical.