class UriSigner in Zircon Profile 8.0

Signs URIs.

@author Fabien Potencier <[e-mail]>

Hierarchy

• class \Symfony\Component\HttpKernel\UriSigner

7 files declare their use of UriSigner

AbstractSurrogateFragmentRenderer.php in vendor/symfony/http-kernel/Fragment/AbstractSurrogateFragmentRenderer.php

EsiFragmentRendererTest.php in vendor/symfony/http-kernel/Tests/Fragment/EsiFragmentRendererTest.php

FragmentListener.php in vendor/symfony/http-kernel/EventListener/FragmentListener.php

FragmentListenerTest.php in vendor/symfony/http-kernel/Tests/EventListener/FragmentListenerTest.php

HIncludeFragmentRenderer.php in vendor/symfony/http-kernel/Fragment/HIncludeFragmentRenderer.php

... See full list

File

vendor/symfony/http-kernel/UriSigner.php, line 19

Namespace

Symfony\Component\HttpKernel

class UriSigner {
  private $secret;

  /**
   * Constructor.
   *
   * @param string $secret A secret
   */
  public function __construct($secret) {
    $this->secret = $secret;
  }

  /**
   * Signs a URI.
   *
   * The given URI is signed by adding a _hash query string parameter
   * which value depends on the URI and the secret.
   *
   * @param string $uri A URI to sign
   *
   * @return string The signed URI
   */
  public function sign($uri) {
    $url = parse_url($uri);
    if (isset($url['query'])) {
      parse_str($url['query'], $params);
    }
    else {
      $params = array();
    }
    $uri = $this
      ->buildUrl($url, $params);
    return $uri . (false === strpos($uri, '?') ? '?' : '&') . '_hash=' . $this
      ->computeHash($uri);
  }

  /**
   * Checks that a URI contains the correct hash.
   *
   * The _hash query string parameter must be the last one
   * (as it is generated that way by the sign() method, it should
   * never be a problem).
   *
   * @param string $uri A signed URI
   *
   * @return bool True if the URI is signed correctly, false otherwise
   */
  public function check($uri) {
    $url = parse_url($uri);
    if (isset($url['query'])) {
      parse_str($url['query'], $params);
    }
    else {
      $params = array();
    }
    if (empty($params['_hash'])) {
      return false;
    }
    $hash = urlencode($params['_hash']);
    unset($params['_hash']);
    return $this
      ->computeHash($this
      ->buildUrl($url, $params)) === $hash;
  }
  private function computeHash($uri) {
    return urlencode(base64_encode(hash_hmac('sha256', $uri, $this->secret, true)));
  }
  private function buildUrl(array $url, array $params = array()) {
    ksort($params);
    $url['query'] = http_build_query($params, '', '&');
    $scheme = isset($url['scheme']) ? $url['scheme'] . '://' : '';
    $host = isset($url['host']) ? $url['host'] : '';
    $port = isset($url['port']) ? ':' . $url['port'] : '';
    $user = isset($url['user']) ? $url['user'] : '';
    $pass = isset($url['pass']) ? ':' . $url['pass'] : '';
    $pass = $user || $pass ? "{$pass}@" : '';
    $path = isset($url['path']) ? $url['path'] : '';
    $query = isset($url['query']) && $url['query'] ? '?' . $url['query'] : '';
    $fragment = isset($url['fragment']) ? '#' . $url['fragment'] : '';
    return $scheme . $user . $pass . $host . $port . $path . $query . $fragment;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UriSigner::$secret	private	property
UriSigner::buildUrl	private	function
UriSigner::check	public	function	Checks that a URI contains the correct hash.
UriSigner::computeHash	private	function
UriSigner::sign	public	function	Signs a URI.
UriSigner::__construct	public	function	Constructor.