JWKFetcherTest.php in Auth0 Single Sign On 8.2

Namespace

Auth0\Tests\Helpers

File

vendor/auth0/auth0-php/tests/Helpers/JWKFetcherTest.php

<?php

namespace Auth0\Tests\Helpers;

use Auth0\SDK\Helpers\Cache\CacheHandler;
use Auth0\SDK\Helpers\Cache\FileSystemCacheHandler;
use Auth0\SDK\Helpers\JWKFetcher;
use GuzzleHttp\Psr7\Response;

/**
 * Class JWKFetcherTest.
 *
 * @package Auth0\Tests\Helpers\Cache
 */
class JWKFetcherTest extends \PHPUnit_Framework_TestCase {
  public function testThatGetFormattedReturnsKeys() {
    $test_jwks = file_get_contents(AUTH0_PHP_TEST_JSON_DIR . 'localhost--well-known-jwks-json.json');
    $jwks = new MockJwks([
      new Response(200, [
        'Content-Type' => 'application/json',
      ], $test_jwks),
    ]);
    $jwks_formatted = $jwks
      ->call()
      ->getKeys(uniqid());
    $this
      ->assertCount(2, $jwks_formatted);
    $this
      ->assertArrayHasKey('__test_kid_1__', $jwks_formatted);
    $pem_parts_1 = explode(PHP_EOL, $jwks_formatted['__test_kid_1__']);
    $this
      ->assertCount(4, $pem_parts_1);
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts_1[0]);
    $this
      ->assertEquals('__test_x5c_1__', $pem_parts_1[1]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts_1[2]);
    $pem_parts_2 = explode(PHP_EOL, $jwks_formatted['__test_kid_2__']);
    $this
      ->assertCount(4, $pem_parts_2);
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts_2[0]);
    $this
      ->assertEquals('__test_x5c_2__', $pem_parts_2[1]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts_2[2]);
  }
  public function testThatGetFormattedEmptyJwksReturnsEmptyArray() {
    $jwks = new MockJwks([
      new Response(200, [
        'Content-Type' => 'application/json',
      ], '{}'),
      new Response(200, [
        'Content-Type' => 'application/json',
      ], '{keys:[]}'),
    ]);
    $jwks_formatted = $jwks
      ->call()
      ->getKeys(uniqid());
    $this
      ->assertEquals([], $jwks_formatted);
    $jwks_formatted = $jwks
      ->call()
      ->getKeys(uniqid());
    $this
      ->assertEquals([], $jwks_formatted);
  }
  public function testThatGetFormattedUsesCache() {
    $jwks_body_1 = '{"keys":[{"kid":"abc","x5c":["123"]}]}';
    $jwks_body_2 = '{"keys":[{"kid":"def","x5c":["456"]}]}';
    $jwks = new MockJwks([
      new Response(200, [
        'Content-Type' => 'application/json',
      ], $jwks_body_1),
      new Response(200, [
        'Content-Type' => 'application/json',
      ], $jwks_body_2),
    ], [
      'cache' => new FileSystemCacheHandler(),
    ]);
    $jwks_formatted_1 = $jwks
      ->call()
      ->getKeys('__test_url__');
    $this
      ->assertArrayHasKey('abc', $jwks_formatted_1);
    $this
      ->assertContains('123', $jwks_formatted_1['abc']);
    $jwks_formatted_2 = $jwks
      ->call()
      ->getKeys('__test_url__');
    $this
      ->assertEquals($jwks_formatted_1, $jwks_formatted_2);
  }

  /**
   * Test that a standard JWKS path returns the first x5c.
   *
   * @return void
   */
  public function testGetJwksX5cWithoutKid() {
    $jwksFetcher = $this
      ->getStub();
    $pem = $jwksFetcher
      ->requestJwkX5c('https://localhost/.well-known/jwks.json');
    $this
      ->assertNotEmpty($pem);
    $pem_parts = explode(PHP_EOL, $pem);
    $this
      ->assertEquals(4, count($pem_parts));
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts[0]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts[2]);
    $this
      ->assertEquals('__test_x5c_1__', $pem_parts[1]);
  }

  /**
   * Test that a standard JWKS path returns the correct x5c when given a kid.
   *
   * @return void
   */
  public function testGetJwksX5cWithKid() {
    $jwksFetcher = $this
      ->getStub();
    $pem = $jwksFetcher
      ->requestJwkX5c('https://localhost/.well-known/jwks.json', '__test_kid_2__');
    $this
      ->assertNotEmpty($pem);
    $pem_parts = explode(PHP_EOL, $pem);
    $this
      ->assertEquals(4, count($pem_parts));
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts[0]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts[2]);
    $this
      ->assertEquals('__test_x5c_2__', $pem_parts[1]);
  }

  /**
   * Test that a custom JWKS path returns the correct JSON.
   *
   * @return void
   */
  public function testGetJwksX5cWithPath() {
    $jwksFetcher = $this
      ->getStub();
    $pem = $jwksFetcher
      ->requestJwkX5c('https://localhost/.custom/jwks.json', '__test_custom_kid__');
    $this
      ->assertNotEmpty($pem);
    $pem_parts = explode(PHP_EOL, $pem);
    $this
      ->assertEquals(4, count($pem_parts));
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts[0]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts[2]);
    $this
      ->assertEquals('__test_custom_x5c__', $pem_parts[1]);
  }

  /**
   * Test that a JWK with no x509 cert returns a blank array.
   *
   * @return void
   */
  public function testGetJwksX5cNoX5c() {
    $jwksFetcher = $this
      ->getStub();
    $pem = $jwksFetcher
      ->requestJwkX5c('https://localhost/.custom/jwks.json', '__no_x5c_test_kid_2__');
    $this
      ->assertEmpty($pem);
  }

  /**
   * Test that the protected getProp method returns correctly.
   *
   * @return void
   */
  public function testConvertCertToPem() {
    $class = new \ReflectionClass(JWKFetcher::class);
    $method = $class
      ->getMethod('convertCertToPem');
    $method
      ->setAccessible(true);
    $test_string_1 = '';
    for ($i = 1; $i <= 64; $i++) {
      $test_string_1 .= 'a';
    }
    $test_string_2 = '';
    for ($i = 1; $i <= 64; $i++) {
      $test_string_2 .= 'b';
    }
    $returned_pem = $method
      ->invoke(new JWKFetcher(), $test_string_1 . $test_string_2);
    $pem_parts = explode(PHP_EOL, $returned_pem);
    $this
      ->assertEquals(5, count($pem_parts));
    $this
      ->assertEquals('-----BEGIN CERTIFICATE-----', $pem_parts[0]);
    $this
      ->assertEquals($test_string_1, $pem_parts[1]);
    $this
      ->assertEquals($test_string_2, $pem_parts[2]);
    $this
      ->assertEquals('-----END CERTIFICATE-----', $pem_parts[3]);
  }

  /**
   * Test that the requestJwkX5c method returns a cached value, if set.
   *
   * @return void
   */
  public function testCacheReturn() {
    $jwks_url = 'https://localhost/.well-known/jwks.json';
    $kid = '__test_kid_2__';
    $cache_value = '__cached_value__';
    $set_spy = $this
      ->once();
    $get_spy = $this
      ->any();

    // Mock the CacheHandler interface.
    $cache_handler = $this
      ->getMockBuilder(CacheHandler::class)
      ->getMock();

    // The set method should only be called once.
    $cache_handler
      ->expects($set_spy)
      ->method('set')
      ->willReturn(null);

    // The get method should be called once and return no cache first, then a cache value after.
    $cache_handler
      ->expects($get_spy)
      ->method('get')
      ->will($this
      ->onConsecutiveCalls(null, $cache_value));
    $jwksFetcher = $this
      ->getStub($cache_handler);
    $pem_not_cached = $jwksFetcher
      ->requestJwkX5c($jwks_url, $kid);
    $this
      ->assertNotEmpty($pem_not_cached);
    $pem_cached = $jwksFetcher
      ->requestJwkX5c($jwks_url, $kid);
    $this
      ->assertEquals($cache_value, $pem_cached);

    // Test that the set method was called with the correct parameters.
    $set_invocations = $set_spy
      ->getInvocations();
    $this
      ->assertEquals($jwks_url . '|' . $kid, $set_invocations[0]->parameters[0]);
    $this
      ->assertEquals($pem_not_cached, $set_invocations[0]->parameters[1]);

    // Test that the get method was only called twice.
    $this
      ->assertEquals(2, $get_spy
      ->getInvocationCount());
  }

  /*
   *
   * Test helper functions.
   *
   */

  /**
   * Get a test JSON fixture instead of a remote one.
   *
   * @param string $domain Domain name of the JWKS.
   * @param string $path   Path to the JWKS.
   *
   * @return array
   */
  public function getLocalJwks($domain = '', $path = '') {

    // Normalize the domain to a file name.
    $domain = str_replace('https://', '', $domain);
    $domain = str_replace('http://', '', $domain);

    // Replace everything that isn't a letter, digit, or dash.
    $pattern = '/[^a-zA-Z1-9^-]/i';
    $file_append = preg_replace($pattern, '-', $domain) . preg_replace($pattern, '-', $path);

    // Get the test JSON file.
    $json_contents = file_get_contents(AUTH0_PHP_TEST_JSON_DIR . $file_append . '.json');
    return json_decode($json_contents, true);
  }

  /**
   * Stub the JWKFetcher class.
   *
   * @param CacheHandler|null $cache_handler Cache handler to use or null if no cache.
   *
   * @return \PHPUnit_Framework_MockObject_MockObject
   */
  private function getStub($cache_handler = null) {
    $stub = $this
      ->getMockBuilder(JWKFetcher::class)
      ->setConstructorArgs([
      $cache_handler,
    ])
      ->setMethods([
      'requestJwks',
    ])
      ->getMock();
    $stub
      ->method('requestJwks')
      ->will($this
      ->returnCallback([
      $this,
      'getLocalJwks',
    ]));
    return $stub;
  }

}

Classes

Name	Description
JWKFetcherTest	Class JWKFetcherTest.