Allow time to be fetched from a universal clock ⏱

src/Provider/AbstractProvider.php

@@ -98,6 +98,11 @@ abstract class AbstractProvider
      */
     protected $optionProvider;
 
+    /**
+     * @var Clock
+     */
+    protected $clock;
+
     /**
      * Constructs an OAuth 2.0 service provider.
      *
@@ -138,6 +143,11 @@ public function __construct(array $options = [], array $collaborators = [])
             $collaborators['optionProvider'] = new PostAuthOptionProvider();
         }
         $this->setOptionProvider($collaborators['optionProvider']);
+
+        if (empty($collaborators['clock'])) {
+            $collaborators['clock'] = new Clock();
+        }
+        $this->setClock($collaborators['clock']);
     }
 
     /**
@@ -252,6 +262,31 @@ public function getOptionProvider()
         return $this->optionProvider;
     }
 
+    /**
+     * Sets the clock.
+     *
+     * @param  Clock $clock
+     *
+     * @return self
+     */
+    public function setClock(Clock $clock)
+    {
+        $this->clock = $clock;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the clock.
+     *
+     * @return Clock
+     */
+    public function getClock()
+    {
+        return $this->clock;
+    }
+
     /**
      * Returns the current value of the state parameter.
      *
@@ -541,6 +576,7 @@ public function getAccessToken($grant, array $options = [])
             );
         }
         $prepared = $this->prepareAccessTokenResponse($response);
+        $prepared['clock'] = $this->clock;
         $token    = $this->createAccessToken($prepared, $grant);
 
         return $token;

src/Provider/Clock.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace League\OAuth2\Client\Provider;
+
+/**
+ * Represents an implementation of a Clock.
+ */
+class Clock
+{
+
+  /**
+   * Get the current time.
+   *
+   * @return \DateTimeImmutable
+   */
+    public function now()
+    {
+        return new \DateTimeImmutable();
+    }
+}

src/Token/AccessToken.php

@@ -15,6 +15,7 @@
 namespace League\OAuth2\Client\Token;
 
 use InvalidArgumentException;
+use League\OAuth2\Client\Provider\Clock;
 use RuntimeException;
 
 /**
@@ -50,12 +51,21 @@ class AccessToken implements AccessTokenInterface, ResourceOwnerAccessTokenInter
     protected $values = [];
 
     /**
-     * @var int
+     * The current time, or NULL to get the true current time via PHP.
+     *
+     * @var int|null
      */
     private static $timeNow;
 
     /**
-     * Set the time now. This should only be used for testing purposes.
+     * The clock.
+     *
+     * @var Clock
+     */
+    protected $clock;
+
+    /**
+     * Sets the current time.
      *
      * @param int $timeNow the time in seconds since epoch
      * @return void
@@ -66,7 +76,7 @@ public static function setTimeNow($timeNow)
     }
 
     /**
-     * Reset the time now if it was set for test purposes.
+     * Reset the current time so the true current time via PHP is used.
      *
      * @return void
      */
@@ -76,11 +86,25 @@ public static function resetTimeNow()
     }
 
     /**
-     * @return int
+     * @inheritdoc
+     */
+    public function setClock(Clock $clock)
+    {
+        $this->clock = $clock;
+    }
+
+    /**
+     * @inheritdoc
      */
     public function getTimeNow()
     {
-        return self::$timeNow ? self::$timeNow : time();
+        if (self::$timeNow) {
+            return self::$timeNow;
+        } elseif (isset($this->clock)) {
+            return $this->clock->now()->getTimestamp();
+        } else {
+            return time();
+        }
     }
 
     /**
@@ -106,6 +130,10 @@ public function __construct(array $options = [])
             $this->refreshToken = $options['refresh_token'];
         }
 
+        if (!empty($options['clock'])) {
+            $this->clock = $options['clock'];
+        }
+
         // We need to know when the token expires. Show preference to
         // 'expires_in' since it is defined in RFC6749 Section 5.1.
         // Defer to 'expires' if it is provided instead.
@@ -196,7 +224,7 @@ public function hasExpired()
             throw new RuntimeException('"expires" is not set on the token');
         }
 
-        return $expires < time();
+        return $expires < $this->getTimeNow();
     }
 
     /**

src/Token/AccessTokenInterface.php

@@ -15,6 +15,7 @@
 namespace League\OAuth2\Client\Token;
 
 use JsonSerializable;
+use League\OAuth2\Client\Provider\Clock;
 use RuntimeException;
 
 interface AccessTokenInterface extends JsonSerializable
@@ -69,4 +70,20 @@ public function __toString();
      * @return array
      */
     public function jsonSerialize();
+
+    /**
+     * Sets the clock.
+     *
+     * @param Clock $clock a clock.
+     *
+     * @return void
+     */
+    public function setClock(Clock $clock);
+
+    /**
+     * Get the current time, whether real or simulated.
+     *
+     * @return int
+     */
+    public function getTimeNow();
 }

src/Tool/MacAuthorizationTrait.php

@@ -14,6 +14,7 @@
 
 namespace League\OAuth2\Client\Tool;
 
+use League\OAuth2\Client\Provider\Clock;
 use League\OAuth2\Client\Token\AccessToken;
 use League\OAuth2\Client\Token\AccessTokenInterface;
 
@@ -24,6 +25,12 @@
  */
 trait MacAuthorizationTrait
 {
+
+    /**
+     * @var Clock
+     */
+    protected $clock;
+
     /**
      * Returns the id of this token for MAC generation.
      *
@@ -68,7 +75,7 @@ protected function getAuthorizationHeaders($token = null)
             return [];
         }
 
-        $ts    = time();
+        $ts    = $this->clock->now()->getTimestamp();
         $id    = $this->getTokenId($token);
         $nonce = $this->getRandomState(16);
         $mac   = $this->getMacSignature($id, $ts, $nonce);

test/src/Provider/AbstractProviderTest.php

@@ -3,6 +3,7 @@
 namespace League\OAuth2\Client\Test\Provider;
 
 use League\OAuth2\Client\OptionProvider\PostAuthOptionProvider;
+use League\OAuth2\Client\Provider\Clock;
 use Mockery;
 use ReflectionClass;
 use UnexpectedValueException;
@@ -24,6 +25,14 @@
 
 class AbstractProviderTest extends TestCase
 {
+
+    /**
+     * The current simulated time.
+     *
+     * @var int
+     */
+    const NOW = 1359504000;
+
     protected function getMockProvider()
     {
         return new MockProvider([
@@ -41,6 +50,14 @@ public function testGetOptionProvider()
         );
     }
 
+    public function testGetClock()
+    {
+        $this->assertInstanceOf(
+            Clock::class,
+            $this->getMockProvider()->getClock()
+        );
+    }
+
     public function testInvalidGrantString()
     {
         $this->expectException(InvalidGrantException::class);
@@ -504,7 +521,7 @@ public function testGetAccessToken($method)
 
         $provider->setAccessTokenMethod($method);
 
-        $raw_response = ['access_token' => 'okay', 'expires' => time() + 3600, 'resource_owner_id' => 3];
+        $raw_response = ['access_token' => 'okay', 'expires' => static::NOW + 3600, 'resource_owner_id' => 3];
 
         $grant = Mockery::mock(AbstractGrant::class);
         $grant
@@ -538,6 +555,9 @@ public function testGetAccessToken($method)
         ]);
 
         $provider->setHttpClient($client);
+        $clock = (new ProgrammableClock())
+            ->setTime(new \DateTimeImmutable('1st February 2013 1pm'));
+        $provider->setClock($clock);
         $token = $provider->getAccessToken($grant, ['code' => 'mock_authorization_code']);
 
         $this->assertInstanceOf(AccessTokenInterface::class, $token);
@@ -546,6 +566,13 @@ public function testGetAccessToken($method)
         $this->assertSame($raw_response['access_token'], $token->getToken());
         $this->assertSame($raw_response['expires'], $token->getExpires());
 
+        // Set the time to a different value so we know references to the
+        // original clock object in provider was not lost.
+        $newTime = new \DateTimeImmutable('2nd February 2013 1pm');
+        $clock->setTime($newTime);
+
+        $this->assertEquals($newTime->getTimestamp(), $token->getTimeNow());
+
         $client
             ->shouldHaveReceived('send')
             ->once()
@@ -786,7 +813,7 @@ public function testExtendedProviderDoesNotErrorWhenUsingAccessTokenAsTheTypeHin
         $token = new AccessToken([
             'access_token' => 'mock_access_token',
             'refresh_token' => 'mock_refresh_token',
-            'expires' => time(),
+            'expires' => 123,
             'resource_owner_id' => 'mock_resource_owner_id',
         ]);
 

test/src/Provider/FrozenClock.php

@@ -0,0 +1,29 @@
+<?php
+
+namespace League\OAuth2\Client\Test\Provider;
+
+use League\OAuth2\Client\Provider\Clock;
+
+/**
+ * A clock with a frozen time for testing.
+ */
+class FrozenClock extends Clock
+{
+
+    /**
+     * The simulated time.
+     *
+     * Evaluates to 1st January 2015 @ 12pm.
+     *
+     * @var int
+     */
+    const NOW = 1420113600;
+
+    /**
+     * @inheritdoc
+     */
+    public function now()
+    {
+        return (new \DateTimeImmutable('@' . static::NOW));
+    }
+}

test/src/Provider/ProgrammableClock.php

@@ -0,0 +1,41 @@
+<?php
+
+namespace League\OAuth2\Client\Test\Provider;
+
+use League\OAuth2\Client\Provider\Clock;
+
+/**
+ * A clock which must be initialised, and may be changed at any time.
+ */
+class ProgrammableClock extends Clock
+{
+
+    /**
+     * @var \DateTimeImmutable|null
+     */
+    protected $time = null;
+
+    /**
+     * @inheritdoc
+     */
+    public function now()
+    {
+        if (!isset($this->time)) {
+            throw new \LogicException('Time must be set explicitly');
+        }
+        return $this->time;
+    }
+
+    /**
+     * Sets the current time.
+     *
+     * @param \DateTimeImmutable|null the current time.
+     * @return self
+     */
+    public function setTime($time)
+    {
+        $this->time = $time;
+
+        return $this;
+    }
+}