Differential D20250 Diff 48331 src/xsprintf/PhutilQueryString.php

Changeset View

Standalone View

src/xsprintf/PhutilQueryString.php

<?php		<?php

final class PhutilQueryString extends Phobject {		final class PhutilQueryString extends Phobject {

private $maskedString;		private $maskedString;
private $unmaskedString;		private $unmaskedString;
		private $isMasked;

public function __construct(PhutilQsprintfInterface $escaper, array $argv) {		public function __construct(PhutilQsprintfInterface $escaper, array $argv) {
// Immediately render the query into a static scalar value.		// Immediately render the query into a static scalar value.

// This makes sure we throw immediately if there are errors in the		// This makes sure we throw immediately if there are errors in the
// parameters, which is much better than throwing later on.		// parameters, which is much better than throwing later on.

// This also makes sure that later mutations to objects passed as		// This also makes sure that later mutations to objects passed as
Show All 10 Lines	public function __construct(PhutilQsprintfInterface $escaper, array $argv) {
$masked_string = xsprintf(		$masked_string = xsprintf(
'xsprintf_query',		'xsprintf_query',
array(		array(
'escaper' => $escaper,		'escaper' => $escaper,
'unmasked' => false,		'unmasked' => false,
),		),
$argv);		$argv);

		// As an optimization, only render the unmasked string if it may differ
		// from the masked string. The strings may differ if any argument is a
		// "PhutilOpaqueEnvelope", or if any argument is a "PhutilQueryString"
		// with different masked and unmasked values.

		// We always render the masked string and only render the unmasked string
		// if we believe we need it, so a mistake here will cause us to incorrectly
		// execute a query with "********" in it, not incorrectly disclose
		// sensitive query parameters.

		$need_unmasked = false;
		foreach ($argv as $arg) {
		if ($arg instanceof PhutilQueryString) {
		if ($arg->isMasked) {
		$need_unmasked = true;
		break;
		}
		continue;
		}

		if ($arg instanceof PhutilOpaqueEnvelope) {
		$need_unmasked = true;
		break;
		}

		if (is_array($arg)) {
		foreach ($arg as $item) {
		if ($item instanceof PhutilQueryString) {
		if ($item->isMasked) {
		$need_unmasked = true;
		break;
		}
		continue;
		}

		// If we find an array item which is not a "PhutilQueryString", we
		// know this argument can not require us to unmask the string, since
		// no valid argument to "qsprintf(...)" may be a list with a mixture
		// of query strings and other values.
		break;
		}
		}
		}

		if ($need_unmasked) {
$unmasked_string = xsprintf(		$unmasked_string = xsprintf(
'xsprintf_query',		'xsprintf_query',
array(		array(
'escaper' => $escaper,		'escaper' => $escaper,
'unmasked' => true,		'unmasked' => true,
),		),
$argv);		$argv);
		$this->isMasked = true;
		} else {
		$unmasked_string = $masked_string;
		$this->isMasked = false;
		}

$this->maskedString = $masked_string;		$this->maskedString = $masked_string;
$this->unmaskedString = $unmasked_string;		$this->unmaskedString = $unmasked_string;
}		}

public function __toString() {		public function __toString() {
return $this->getMaskedString();		return $this->getMaskedString();
}		}
Show All 10 Lines