Skip to content

Escape DHL rate XML fields #328

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
haradahinata wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Escape DHL rate XML fields #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
62ed6ae
Escape DHL rate XML fields
haradahinata May 17, 2026
5246a91
Harden DHL XML escape guard test
haradahinata May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 28 additions & 13 deletions common/models/shipping/Dhlexpress.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,14 +97,20 @@ public function getQuote($address) {
$pieces = ShippingHelper::get_package_piece($dhl_packs);
$weight_unit = 'KG';
$dim_unit = 'CM';
$fetch_accountrates = ($rate_type == 'ACCOUNT') ? "<PaymentAccountNumber>" . $dhlexpress_account . "</PaymentAccountNumber>" : "";
$fetch_accountrates = ($rate_type == 'ACCOUNT') ? "<PaymentAccountNumber>" . $this->escapeXmlValue($dhlexpress_account) . "</PaymentAccountNumber>" : "";

$mailing_date = date('Y-m-d');
$mailing_datetime = date('c');
$origin_postcode_city = ShippingHelper::get_postcode_city($fromCountryCode, $fromCity, $fromPostcode);
$origin_postcode_city = ShippingHelper::get_postcode_city(
$fromCountryCode,
$this->escapeXmlValue($fromCity),
$this->escapeXmlValue($fromPostcode)
);
//$total_value = $this->cart->get_total();

$dutiable_content = ($is_dutiable == "Y") ? "<Dutiable><DeclaredCurrency>{$selected_currency}</DeclaredCurrency><DeclaredValue>{$total_value}</DeclaredValue></Dutiable>" : "";
$declared_currency = $this->escapeXmlValue($selected_currency);
$declared_value = $this->escapeXmlValue($total_value);
$dutiable_content = ($is_dutiable == "Y") ? "<Dutiable><DeclaredCurrency>{$declared_currency}</DeclaredCurrency><DeclaredValue>{$declared_value}</DeclaredValue></Dutiable>" : "";

//$insurance_details = ($this->config->get('shipping_dhlexpress_insurance') == true) ? "<InsuredValue>". $total_value ."</InsuredValue><InsuredCurrency>". $this->config->get('config_currency') ."</InsuredCurrency>" : "";
//$additional_insurance_details = ($this->config->get('shipping_dhlexpress_insurance') == true) ? "<QtdShp><QtdShpExChrg><SpecialServiceType>II</SpecialServiceType><LocalSpecialServiceType>XCH</LocalSpecialServiceType></QtdShpExChrg></QtdShp>" : ""; //
Expand All @@ -130,7 +136,11 @@ public function getQuote($address) {
}
}*/

$destination_postcode_city = ShippingHelper::get_postcode_city($county_code_to, $to_city, $postcode);
$destination_postcode_city = ShippingHelper::get_postcode_city(
$county_code_to,
$this->escapeXmlValue($to_city),
$this->escapeXmlValue($postcode)
);
$payment_country = $county_code_to;// $this->config->get('shipping_dhlexpress_country_code');

/*if ( !empty($this->config->get('shipping_dhlexpress_pay_con')) && $this->config->get('shipping_dhlexpress_pay_con') == "R" ) {
Expand All @@ -149,31 +159,31 @@ public function getQuote($address) {
$xml .= ' <ServiceHeader>';
$xml .= ' <MessageTime>'.$mailing_datetime.'</MessageTime>';
$xml .= ' <MessageReference>1234567890123456789012345678901</MessageReference>';
$xml .= ' <SiteID>'.$dhlexpress_key.'</SiteID>';
$xml .= ' <Password>'.$dhlexpress_password.'</Password>';
$xml .= ' <SiteID>'.$this->escapeXmlValue($dhlexpress_key).'</SiteID>';
$xml .= ' <Password>'.$this->escapeXmlValue($dhlexpress_password).'</Password>';
$xml .= ' </ServiceHeader>';
$xml .= ' </Request>';
$xml .= ' <From>';
$xml .= ' <CountryCode>'.$fromCountryCode.'</CountryCode>';
$xml .= ' <CountryCode>'.$this->escapeXmlValue($fromCountryCode).'</CountryCode>';
$xml .= ' '.$origin_postcode_city;
$xml .= ' </From>';
$xml .= ' <BkgDetails> ';
$xml .= ' <PaymentCountryCode>'.$payment_country.'</PaymentCountryCode>';
$xml .= ' <PaymentCountryCode>'.$this->escapeXmlValue($payment_country).'</PaymentCountryCode>';
$xml .= ' <Date>'.$mailing_date.'</Date>';
$xml .= ' <ReadyTime>PT10H21M</ReadyTime>';
$xml .= ' <DimensionUnit>'.$dim_unit.'</DimensionUnit>';
$xml .= ' <WeightUnit>'.$weight_unit.'</WeightUnit>';
$xml .= ' <DimensionUnit>'.$this->escapeXmlValue($dim_unit).'</DimensionUnit>';
$xml .= ' <WeightUnit>'.$this->escapeXmlValue($weight_unit).'</WeightUnit>';
$xml .= ' <Pieces>';
$xml .= ' '.$pieces;
$xml .= ' </Pieces>';
$xml .= ' '.$fetch_accountrates;
$xml .= ' <IsDutiable>'.$is_dutiable.'</IsDutiable>';
$xml .= ' <IsDutiable>'.$this->escapeXmlValue($is_dutiable).'</IsDutiable>';
$xml .= ' <NetworkTypeCode>AL</NetworkTypeCode>';
//$xml .= ' '.$additional_insurance_details;
//$xml .= ' '.$insurance_details;
$xml .= ' </BkgDetails>';
$xml .= ' <To>';
$xml .= ' <CountryCode>'.$county_code_to.'</CountryCode>';
$xml .= ' <CountryCode>'.$this->escapeXmlValue($county_code_to).'</CountryCode>';
$xml .= ' '.$destination_postcode_city;
$xml .= ' </To>';
$xml .= ' '.$dutiable_content;
Expand Down Expand Up @@ -261,4 +271,9 @@ public function getQuote($address) {
}
return $method_data;
}
}

private function escapeXmlValue($value)
{
return htmlspecialchars((string) $value, ENT_XML1 | ENT_QUOTES, 'UTF-8');
}
}
53 changes: 53 additions & 0 deletions tests/check-dhl-rate-xml-escaping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
from pathlib import Path
import re


dhl = Path("common/models/shipping/Dhlexpress.php")
source = dhl.read_text(encoding="utf-8")

required_patterns = [
r"private\s+function\s+escapeXmlValue\s*\(\s*\$value\s*\)",
r"htmlspecialchars\s*\(\s*\(string\)\s*\$value\s*,\s*ENT_XML1\s*\|\s*ENT_QUOTES\s*,\s*'UTF-8'\s*\)",
r"<PaymentAccountNumber>\"\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$dhlexpress_account\s*\)\s*\.\s*\"</PaymentAccountNumber>",
r"\$this->escapeXmlValue\s*\(\s*\$fromCity\s*\)",
r"\$this->escapeXmlValue\s*\(\s*\$fromPostcode\s*\)",
r"\$this->escapeXmlValue\s*\(\s*\$to_city\s*\)",
r"\$this->escapeXmlValue\s*\(\s*\$postcode\s*\)",
r"\$declared_currency\s*=\s*\$this->escapeXmlValue\s*\(\s*\$selected_currency\s*\)",
r"\$declared_value\s*=\s*\$this->escapeXmlValue\s*\(\s*\$total_value\s*\)",
r"<DeclaredCurrency>\{\$declared_currency\}</DeclaredCurrency>",
r"<DeclaredValue>\{\$declared_value\}</DeclaredValue>",
r"<SiteID>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$dhlexpress_key\s*\)\s*\.\s*'</SiteID>",
r"<Password>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$dhlexpress_password\s*\)\s*\.\s*'</Password>",
r"<CountryCode>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$fromCountryCode\s*\)\s*\.\s*'</CountryCode>",
r"<PaymentCountryCode>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$payment_country\s*\)\s*\.\s*'</PaymentCountryCode>",
r"<DimensionUnit>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$dim_unit\s*\)\s*\.\s*'</DimensionUnit>",
r"<WeightUnit>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$weight_unit\s*\)\s*\.\s*'</WeightUnit>",
r"<IsDutiable>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$is_dutiable\s*\)\s*\.\s*'</IsDutiable>",
r"<CountryCode>'\s*\.\s*\$this->escapeXmlValue\s*\(\s*\$county_code_to\s*\)\s*\.\s*'</CountryCode>",
]

missing = [pattern for pattern in required_patterns if not re.search(pattern, source)]
if missing:
raise SystemExit(
"DHL Express XML is missing expected escaping patterns: "
+ ", ".join(missing)
)

unsafe_patterns = [
r"<PaymentAccountNumber>\"\s*\.\s*\$dhlexpress_account\s*\.\s*\"</PaymentAccountNumber>",
r"ShippingHelper::get_postcode_city\s*\(\s*\$fromCountryCode\s*,\s*\$fromCity\s*,\s*\$fromPostcode\s*\)",
r"ShippingHelper::get_postcode_city\s*\(\s*\$county_code_to\s*,\s*\$to_city\s*,\s*\$postcode\s*\)",
r"<SiteID>'\s*\.\s*\$dhlexpress_key\s*\.\s*'</SiteID>",
r"<Password>'\s*\.\s*\$dhlexpress_password\s*\.\s*'</Password>",
r"<CountryCode>'\s*\.\s*\$fromCountryCode\s*\.\s*'</CountryCode>",
r"<PaymentCountryCode>'\s*\.\s*\$payment_country\s*\.\s*'</PaymentCountryCode>",
r"<DimensionUnit>'\s*\.\s*\$dim_unit\s*\.\s*'</DimensionUnit>",
r"<WeightUnit>'\s*\.\s*\$weight_unit\s*\.\s*'</WeightUnit>",
r"<IsDutiable>'\s*\.\s*\$is_dutiable\s*\.\s*'</IsDutiable>",
r"<CountryCode>'\s*\.\s*\$county_code_to\s*\.\s*'</CountryCode>",
]

for unsafe_pattern in unsafe_patterns:
if re.search(unsafe_pattern, source):
raise SystemExit(f"DHL Express XML still writes raw value pattern: {unsafe_pattern}")