Merge pull request #107 from ydb-platform/create-private-refresh-ratio-token-parametr

Created refresh token ratio parameter

Author: ilyakharev

CHANGELOG.md

@@ -1,3 +1,5 @@
+* created refresh token ratio parameter
+
 ## 1.9.0
 
 * added microseconds in Timestamp type

src/Auth/Auth.php

@@ -13,6 +13,8 @@ public abstract function getName(): string;
 
     protected $logger;
 
+    protected $refreshTokenRatio;
+
     public function logger(){
         return $this->logger;
     }
@@ -21,6 +23,25 @@ public function setLogger($logger){
         $this->logger = $logger;
     }
 
+    /**
+     * @return float
+     */
+    public function getRefreshTokenRatio(): float
+    {
+        return $this->refreshTokenRatio;
+    }
+
+    /**
+     * @param float $refreshTokenRatio
+     */
+    public function setRefreshTokenRatio($refreshTokenRatio): void
+    {
+        if($refreshTokenRatio<=0||$refreshTokenRatio>=1){
+            throw new \Exception("Refresh token ratio. Expected number between 0 and 1.");
+        }
+        $this->refreshTokenRatio = $refreshTokenRatio;
+    }
+
     /**
      * @param string $expiresAt
      * @return int

src/Auth/Implement/AccessTokenAuthentication.php

@@ -18,7 +18,7 @@ public function __construct(string $access_token)
 
     public function getTokenInfo(): TokenInfo
     {
-        return new TokenInfo($this->access_token, time()+24*60*60);
+        return new TokenInfo($this->access_token, time()+24*60*60, $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/Implement/AnonymousAuthentication.php

@@ -13,7 +13,7 @@ public function __construct()
 
     public function getTokenInfo(): TokenInfo
     {
-        return new TokenInfo("", time()+24*3600);
+        return new TokenInfo("", time()+24*3600, $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/Implement/JwtWithJsonAuthentication.php

@@ -35,7 +35,7 @@ public function getTokenInfo(): TokenInfo
             'jwt' => $jwt_token,
         ];
         $token = $this->requestToken($request_data);
-        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt));
+        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt), $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/Implement/JwtWithPrivateKeyAuthentication.php

@@ -29,7 +29,7 @@ public function getTokenInfo(): TokenInfo
             'jwt' => $jwt_token,
         ];
         $token = $this->requestToken($request_data);
-        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt));
+        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt), $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/Implement/MetadataAuthentication.php

@@ -12,7 +12,7 @@ class MetadataAuthentication extends \YdbPlatform\Ydb\Auth\Auth
     public function getTokenInfo(): TokenInfo
     {
         $token = $this->requestTokenFromMetadata();
-        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt));
+        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt), $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/Implement/OAuthTokenAuthentication.php

@@ -22,7 +22,7 @@ public function getTokenInfo(): TokenInfo
             'yandexPassportOauthToken' => $this->oauth_token,
         ];
         $token = $this->requestToken($request_data);
-        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt));
+        return new TokenInfo($token->iamToken, $this->convertExpiresAt($token->expiresAt), $this->refreshTokenRatio);
     }
 
     public function getName(): string

src/Auth/TokenInfo.php

@@ -4,7 +4,6 @@
 
 class TokenInfo
 {
-    const _PRIVATE_REFRESH_RATIO = 0.1;
     /**
      * @var string
      */
@@ -16,11 +15,11 @@ class TokenInfo
 
     private $refreshAt;
 
-    public function __construct(string $token, int $expiresAt)
+    public function __construct(string $token, int $expiresAt, float $refreshRatio = 0.1)
     {
         $this->token = $token;
         $this->expiresAt = $expiresAt;
-        $this->refreshAt = time() + round(TokenInfo::_PRIVATE_REFRESH_RATIO*($this->expiresAt-time()),0);
+        $this->refreshAt = time() + round($refreshRatio*($this->expiresAt-time()),0);
     }
 
     /**

src/Iam.php

@@ -10,6 +10,7 @@
 use YdbPlatform\Ydb\Auth\Implement\AnonymousAuthentication;
 use YdbPlatform\Ydb\Auth\Implement\JwtWithJsonAuthentication;
 use YdbPlatform\Ydb\Auth\Implement\JwtWithPrivateKeyAuthentication;
+use YdbPlatform\Ydb\Auth\Implement\MetadataAuthentication;
 use YdbPlatform\Ydb\Auth\Implement\OAuthTokenAuthentication;
 use YdbPlatform\Ydb\Contracts\IamTokenContract;
 
@@ -153,6 +154,10 @@ protected function parseConfig(array $config)
             $parsedConfig["credentials"] = $config["credentials"];
         }
 
+        if (isset($config["refresh_token_ratio"])){
+            $parsedConfig["refresh_token_ratio"] = $config["refresh_token_ratio"];
+        }
+
         foreach ($stringParams as $param)
         {
             $parsedConfig[$param] = (string)($config[$param] ?? '');
@@ -197,6 +202,8 @@ protected function initConfig()
         else if ($this->config('use_metadata'))
         {
             $this->logger()->info('YDB: Authentication method: Metadata URL');
+            $this->config['credentials'] = new MetadataAuthentication();
+            $this->config['credentials']->setLogger($this->logger());
         }
         else if ($serviceFile = $this->config('service_file'))
         {
@@ -237,6 +244,10 @@ protected function initConfig()
             $this->config['credentials'] = new OAuthTokenAuthentication($oauthToken);
             $this->config['credentials']->setLogger($this->logger());
         }
+
+        if ($this->config('credentials') !== null){
+            $this->config['credentials']->setRefreshTokenRatio($this->config('refresh_token_ratio', 0.1));
+        }
         else
         {
             throw new Exception('No authentication method is used.');