diff --git a/CHANGELOG.TXT b/CHANGELOG.TXT index cd819d6e..94f7a083 100644 --- a/CHANGELOG.TXT +++ b/CHANGELOG.TXT @@ -10,6 +10,9 @@ Changes in 'master' (not in a release yet) (20XX/XX/XX) -------------------------- - Use the concise Spanish "MX de respaldo" label for Backup MX in domain lists and forms. + + - Escape stored application-password and TOTP-exception list values. (see #1172, thanks @TrapoSAMA) + - Require explicit TemplateEscape modes instead of boolean template escaping arguments. (see #1172, thanks @TrapoSAMA) - Treat recipient_delimiter as a set of alternative characters, matching Postfix behavior (see #1143, thanks @MatzeKitt). - Allow mailbox users to edit their own display name in the users/ interface when enabled globally or for selected domains; apply the same name validation to administrative mailbox creation and editing (see #1176, thanks @pvdv and @TrapoSAMA). - Invalidate XML-RPC authorization when web authentication replaces the session, and reject pending MFA sessions. diff --git a/DOCUMENTS/PFASmarty-escaping.md b/DOCUMENTS/PFASmarty-escaping.md new file mode 100644 index 00000000..38a6d6af --- /dev/null +++ b/DOCUMENTS/PFASmarty-escaping.md @@ -0,0 +1,9 @@ +# Template output escaping + +`$smarty->assign($key, $value)` escapes strings recursively for HTML output by default, using `TemplateEscape::HTML`. Keep this default unless you have very good reasons to disable escaping. Never disable escaping for user-supplied text, including nested list values. + +When a value intentionally contains HTML that is already safe for its output context, use `$smarty->assign($key, $value, TemplateEscape::RAW)`. RAW does not validate or sanitise HTML. JSON, JavaScript, URLs and commands need their own context-specific encoding before any intentional HTML-escaping opt-out; the enum does not implement those encoders. + +The third argument is named `sanitise` and accepts only `TemplateEscape::HTML` or `TemplateEscape::RAW`. Boolean arguments, strings and other values throw `TypeError` before any template assignment. There is no intermediate deprecation stage. Replace legacy `true` with the default or `TemplateEscape::HTML`; review each legacy `false` call and remove its opt-out when HTML escaping is appropriate, otherwise use `TemplateEscape::RAW` only for values already safe in their output context. Apply the same migration to dynamically computed mode arguments in integrations. + +The existing `RAW_` template variables remain available for compatibility. They contain the original assigned values and do not provide output-context encoding. The enum requires PHP 8.1 or newer and is supported by master's PHP >=8.2 requirement; this API change must not be copied to the PHP 7.4 branch. diff --git a/model/PFASmarty.php b/model/PFASmarty.php index 528cbe6c..8cb2e7df 100644 --- a/model/PFASmarty.php +++ b/model/PFASmarty.php @@ -122,12 +122,12 @@ class PFASmarty /** * @param string $key * @param mixed $value - * @param bool $sanitise + * @param TemplateEscape $sanitise Output escaping mode; RAW requires data safe for its output context. */ - public function assign($key, $value, $sanitise = true) + public function assign(string $key, mixed $value, TemplateEscape $sanitise = TemplateEscape::HTML) { $this->template->assign("RAW_$key", $value); - if ($sanitise == false) { + if ($sanitise === TemplateEscape::RAW) { return $this->template->assign($key, $value); } $clean = $this->sanitise($value); diff --git a/model/TemplateEscape.php b/model/TemplateEscape.php new file mode 100644 index 00000000..fedf7efd --- /dev/null +++ b/model/TemplateEscape.php @@ -0,0 +1,8 @@ + $_) { } else { $fielderror[$key] = ''; } - $sanitise = true; + $sanitise = TemplateEscape::HTML; if (isset($form_fields[$key]['type']) && $form_fields[$key]['type'] == 'html') { - $sanitise = false; + $sanitise = TemplateEscape::RAW; } if (isset($values[$key])) { diff --git a/public/list-virtual.php b/public/list-virtual.php index a81fb25c..c663a542 100644 --- a/public/list-virtual.php +++ b/public/list-virtual.php @@ -404,9 +404,6 @@ $pagination_mailbox = page_browser_pagination( ); -// this is why we need a proper template layer. -$fDomain = htmlentities($fDomain, ENT_QUOTES); - if (empty($_GET['domain'])) { $_GET['domain'] = ''; } @@ -416,7 +413,7 @@ $smarty->assign('domain_selected', $fDomain); $smarty->assign('pagination_alias', $pagination_alias); $smarty->assign('pagination_mailbox', $pagination_mailbox); -$smarty->assign('fDomain', $fDomain, false); +$smarty->assign('fDomain', $fDomain); $smarty->assign('search', $search); @@ -444,7 +441,7 @@ if ($password_expiration_never_label === '') { } $smarty->assign('password_expiration_on_label', $password_expiration_on_label); $smarty->assign('password_expiration_never_label', $password_expiration_never_label); -$smarty->assign('gen_show_status_mailbox', $gen_show_status_mailbox, false); +$smarty->assign('gen_show_status_mailbox', $gen_show_status_mailbox, TemplateEscape::RAW); $smarty->assign('boolconf_used_quotas', Config::bool('used_quotas')); $smarty->assign('divide_quota', $divide_quota); $smarty->assign('tCanAddMailbox', $tCanAddMailbox); diff --git a/public/login-mfa.php b/public/login-mfa.php index b470afb7..1be2166a 100644 --- a/public/login-mfa.php +++ b/public/login-mfa.php @@ -62,7 +62,7 @@ if ($_SERVER['REQUEST_METHOD'] == "POST") { $smarty->assign('pTOPT_code_text', $error); $smarty->assign('smarty_template', 'login-mfa'); -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('forgotten_password_reset', Config::bool('forgotten_admin_password_reset')); $smarty->display('index.tpl'); diff --git a/public/login.php b/public/login.php index 53e11154..86db7517 100644 --- a/public/login.php +++ b/public/login.php @@ -106,7 +106,7 @@ if ($_SERVER['REQUEST_METHOD'] == "POST") { session_start(); } -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('smarty_template', 'login'); $smarty->assign('logintype', 'admin'); $smarty->assign('forgotten_password_reset', Config::bool('forgotten_admin_password_reset')); diff --git a/public/users/app-passwords.php b/public/users/app-passwords.php index 5dbe3c05..9263d7fa 100644 --- a/public/users/app-passwords.php +++ b/public/users/app-passwords.php @@ -32,9 +32,6 @@ $smarty = PFASmarty::getInstance(); $smarty->configureTheme($smarty->getRelPath()); $username = authentication_get_username(); -$pPassword_text = ""; -$pUser_text = ''; -$pUser = ''; // check if app-passwords are enabled if (Config::bool('app_passwords') === false) { @@ -112,10 +109,7 @@ foreach ($passwords as $n => $pass) { $smarty->assign('SESSID_USERNAME', $username); -$smarty->assign('pPassword_text', $pPassword_text, false); -$smarty->assign('pUser_text', $pUser_text, false); -$smarty->assign('pUser', $pUser, false); -$smarty->assign('pPasswords', $passwords, false); +$smarty->assign('pPasswords', $passwords); $smarty->assign('smarty_template', 'app-passwords'); $smarty->display('index.tpl'); diff --git a/public/users/login-mfa.php b/public/users/login-mfa.php index f2d5a25a..c03fc4ce 100644 --- a/public/users/login-mfa.php +++ b/public/users/login-mfa.php @@ -46,7 +46,7 @@ if ($_SERVER['REQUEST_METHOD'] == "POST") { $smarty->assign('logintype', 'user'); $smarty->assign('smarty_template', 'login-mfa'); -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('forgotten_password_reset', Config::bool('forgotten_admin_password_reset')); $smarty->display('index.tpl'); diff --git a/public/users/login.php b/public/users/login.php index f6c1dfc2..e42eca4f 100644 --- a/public/users/login.php +++ b/public/users/login.php @@ -83,7 +83,7 @@ if ($error) { flash_error($error); } -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('smarty_template', 'login'); $smarty->assign('logintype', 'user'); $smarty->assign('forgotten_password_reset', Config::read('forgotten_user_password_reset') && !Config::read('mailbox_postpassword_script')); diff --git a/public/users/password-change.php b/public/users/password-change.php index 1fd8005b..6147d3c7 100644 --- a/public/users/password-change.php +++ b/public/users/password-change.php @@ -95,7 +95,7 @@ if ($_SERVER['REQUEST_METHOD'] === 'POST') { $totppf = new TotpPf($context === 'admin' ? 'admin' : 'mailbox', new Login($context === 'admin' ? 'admin' : 'mailbox')); $tTotpRequired = $totppf->usesTOTP($tUsername); $smarty->assign('tTotpRequired', $tTotpRequired); -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('tUsername', $tUsername); $smarty->assign('tCode', $tCode); $smarty->assign('smarty_template', 'password-change'); diff --git a/public/users/password-recover.php b/public/users/password-recover.php index d74476b1..c9b08f2d 100644 --- a/public/users/password-recover.php +++ b/public/users/password-recover.php @@ -119,7 +119,7 @@ if ($_SERVER['REQUEST_METHOD'] === "POST") { flash_info(Config::Lang('pPassword_recovery_processed')); } -$smarty->assign('language_selector', language_selector(), false); +$smarty->assign('language_selector', language_selector(), TemplateEscape::RAW); $smarty->assign('smarty_template', 'password-recover'); $smarty->display('index.tpl'); diff --git a/public/users/password.php b/public/users/password.php index 40902ea1..1651634a 100644 --- a/public/users/password.php +++ b/public/users/password.php @@ -87,8 +87,8 @@ if ($_SERVER['REQUEST_METHOD'] == "POST") { } $smarty->assign('SESSID_USERNAME', $username); -$smarty->assign('pPassword_password_current_text', $pPassword_password_current_text, false); -$smarty->assign('pPassword_password_text', $pPassword_password_text, false); +$smarty->assign('pPassword_password_current_text', $pPassword_password_current_text); +$smarty->assign('pPassword_password_text', $pPassword_password_text); $smarty->assign('smarty_template', 'password'); $smarty->display('index.tpl'); diff --git a/public/users/totp-exceptions.php b/public/users/totp-exceptions.php index 3654be50..c6d10923 100644 --- a/public/users/totp-exceptions.php +++ b/public/users/totp-exceptions.php @@ -34,9 +34,6 @@ $smarty->configureTheme($smarty->getRelPath()); $username = authentication_get_username(); list($_, $domain) = explode('@', $username); -$pPassword_text = ""; -$pUser_text = ''; -$pUser = ''; $username = authentication_get_username(); @@ -126,11 +123,7 @@ foreach ($exceptions as $n => $ex) { $smarty->assign('SESSID_USERNAME', $username); -$smarty->assign('pPassword_text', $pPassword_text, false); -$smarty->assign('pUser_text', $pUser_text, false); -$smarty->assign('pUser', $pUser, false); -#$smarty->assign('', $, false); -$smarty->assign('pExceptions', $exceptions, false); +$smarty->assign('pExceptions', $exceptions); $smarty->assign('smarty_template', 'totp-exceptions'); $smarty->display('index.tpl'); diff --git a/public/users/totp.php b/public/users/totp.php index ee7311f8..cd97c305 100644 --- a/public/users/totp.php +++ b/public/users/totp.php @@ -34,13 +34,6 @@ authentication_require_role($required_role); $username = authentication_get_username(); $pPassword_password_current_text = ""; -$pTOTP_now = ""; -$pPassword_password_text = ""; - - -// these get shown if there's an error. -$pTOTP_secret_text = ''; -$pTOTP_code_text = ''; // check if totp is enabled if (Config::bool('totp') === false) { @@ -122,13 +115,9 @@ list($pTOTP_secret, $pQR_raw) = $totppf->generate($username); $smarty->assign('SESSID_USERNAME', $username); $smarty->assign('admin', $admin); -$smarty->assign('pPassword_password_current_text', $pPassword_password_current_text, false); -$smarty->assign('pTOTP_code_text', $pTOTP_code_text, false); -$smarty->assign('pTOTP_secret_text', $pTOTP_secret_text, false); -$smarty->assign('pPassword_password_text', $pPassword_password_text, false); -$smarty->assign('pQR_raw', $pQR_raw, false); -$smarty->assign('pTOTP_secret', $pTOTP_secret, false); -$smarty->assign('pTOTP_now', $pTOTP_now, false); +$smarty->assign('pPassword_password_current_text', $pPassword_password_current_text); +$smarty->assign('pQR_raw', $pQR_raw); +$smarty->assign('pTOTP_secret', $pTOTP_secret); $smarty->assign('smarty_template', 'totp'); $smarty->display('index.tpl'); diff --git a/templates/app-passwords.tpl b/templates/app-passwords.tpl index 6ef0b5ee..39d949d5 100644 --- a/templates/app-passwords.tpl +++ b/templates/app-passwords.tpl @@ -3,13 +3,12 @@

{$PALANG.pApp_passwords_welcome}

{CSRF_Token} -
+
- {$pPassword_text}