summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
author大兵 <dabing.ywb@taobao.com>2013-05-06 05:45:07 +0400
committerBrent Shaffer <bshafs@gmail.com>2013-05-09 18:04:06 +0400
commit12a359eac1b7db13c018a2209f310f7b2e89d5f4 (patch)
treebfa33b704f5622a20e3116d90bb6c79e75eb3c4e
parent8c95c78301896ebbe91a4d759de84d21ea0083e4 (diff)
downloadoauth2-server-php-12a359eac1b7db13c018a2209f310f7b2e89d5f4.tar.xz
cherry-picks redis class
-rw-r--r--src/OAuth2/Controller/AuthorizeController.php2
-rw-r--r--src/OAuth2/Storage/Redis.php195
2 files changed, 196 insertions, 1 deletions
diff --git a/src/OAuth2/Controller/AuthorizeController.php b/src/OAuth2/Controller/AuthorizeController.php
index e3d032f..4e8b71c 100644
--- a/src/OAuth2/Controller/AuthorizeController.php
+++ b/src/OAuth2/Controller/AuthorizeController.php
@@ -151,7 +151,7 @@ class OAuth2_Controller_AuthorizeController implements OAuth2_Controller_Authori
}
// Return retrieved client details together with input
- return array_merge(array('scope' => $scope, 'state' => null), $clientData, $request->getAllQueryParameters(), array('redirect_uri' => $redirect_uri));
+ return array_merge(array('scope' => $scope, 'state' => $state), $clientData, $request->getAllQueryParameters(), array('redirect_uri' => $redirect_uri));
}
/**
diff --git a/src/OAuth2/Storage/Redis.php b/src/OAuth2/Storage/Redis.php
new file mode 100644
index 0000000..bce438e
--- /dev/null
+++ b/src/OAuth2/Storage/Redis.php
@@ -0,0 +1,195 @@
+<?php
+/**
+ * redis storage for all storage types
+ *
+ * Register client:
+ * <code>
+ * $storage = new OAuth2_Storage_Redis($redis);
+ * $storage->registerClient($client_id, $client_secret, $redirect_uri);
+ * </code>
+ */
+class OAuth2_Storage_Redis implements OAuth2_Storage_AuthorizationCodeInterface,
+ OAuth2_Storage_AccessTokenInterface,
+ OAuth2_Storage_ClientCredentialsInterface,
+ OAuth2_Storage_UserCredentialsInterface,
+ OAuth2_Storage_RefreshTokenInterface,
+ OAuth2_Storage_JWTBearerInterface
+{
+ private $redis;
+ private $config;
+ private $cache;
+
+ /**
+ * Redis Storage!
+ *
+ * @param \Predis\Client $redis
+ * @param array $config
+ */
+ public function __construct($redis, $config=array())
+ {
+ $this->redis = $redis;
+ $this->config = array_merge(array(
+ 'client_key' => 'oauth_clients:',
+ 'access_token_key' => 'oauth_access_tokens:',
+ 'refresh_token_key' => 'oauth_refresh_tokens:',
+ 'code_key' => 'oauth_authorization_codes:',
+ 'user_key' => 'oauth_users:',
+ 'jwt_key' => 'oauth_jwt:',
+ ), $config);
+ }
+
+ protected function getValue($key)
+ {
+ if ( isset($this->cache[$key]) ) {
+ return $this->cache[$key];
+ }
+ $value = $this->redis->get($key);
+ if ( isset($value) ) {
+ return json_decode($value, true);
+ } else {
+ return false;
+ }
+ }
+
+ protected function setValue($key, $value, $expire=0)
+ {
+ $this->cache[$key] = $value;
+ $str = json_encode($value);
+ if ( $expire > 0 ) {
+ $seconds = $expire - time();
+ return $this->redis->setex($key, $seconds, $str);
+ } else {
+ return $this->redis->set($key, $str);
+ }
+ }
+
+ protected function expireValue($key)
+ {
+ unset($this->cache[$key]);
+ return $this->redis->expire($key);
+ }
+
+ /* AuthorizationCodeInterface */
+ public function getAuthorizationCode($code)
+ {
+ return $this->getValue($this->config['code_key'] . $code);
+ }
+
+ public function setAuthorizationCode($authorization_code, $client_id, $user_id, $redirect_uri, $expires, $scope = null)
+ {
+ return $this->setValue(
+ $this->config['code_key'] . $authorization_code,
+ compact('authorization_code', 'client_id', 'user_id', 'redirect_uri', 'expires', 'scope'),
+ $expires
+ );
+ }
+
+ public function expireAuthorizationCode($code)
+ {
+ $key = $this->config['code_key'] . $code;
+ unset($this->cache[$key]);
+ return $this->expireValue($key);
+ }
+
+ /* UserCredentialsInterface */
+ public function checkUserCredentials($username, $password)
+ {
+ $user = $this->getUserDetails($username);
+ return $user && $user['password'] === $password;
+ }
+
+ public function getUserDetails($username)
+ {
+ return $this->getUser($username);
+ }
+
+ public function getUser($username)
+ {
+ return $this->getValue($this->config['user_key'] . $username);
+ }
+
+ public function setUser($username, $password, $first_name = null, $last_name = null)
+ {
+ return $this->setValue(
+ $this->config['user_key'] . $username,
+ compact('username', 'password', 'first_name', 'last_name')
+ );
+ }
+
+ /* ClientCredentialsInterface */
+ public function checkClientCredentials($client_id, $client_secret = null)
+ {
+ $client = $this->getClientDetails($client_id);
+ return isset($client['client_secret'])
+ && $client['client_secret'] == $client_secret;
+ }
+
+ public function getClientDetails($client_id)
+ {
+ return $this->getValue($this->config['client_key'] . $client_id);
+ }
+
+ public function checkRestrictedGrantType($client_id, $grant_type)
+ {
+ $details = $this->getClientDetails($client_id);
+ if (isset($details['grant_types'])) {
+ return in_array($grant_type, (array) $details['grant_types']);
+ }
+
+ // if grant_types are not defined, then none are restricted
+ return true;
+ }
+
+ public function registerClient($client_id, $client_secret, $redirect_uri)
+ {
+ return $this->setValue(
+ $this->config['client_key'] . $client_id,
+ compact('client_id', 'client_secret', 'redirect_uri')
+ );
+ }
+
+ /* RefreshTokenInterface */
+ public function getRefreshToken($refresh_token)
+ {
+ return $this->getValue($this->config['refresh_token_key'] . $refresh_token);
+ }
+
+ public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
+ {
+ return $this->setValue(
+ $this->config['refresh_token_key'] . $refresh_token,
+ compact('refresh_token', 'client_id', 'user_id', 'expires', 'scope'),
+ $expires
+ );
+ }
+
+ public function unsetRefreshToken($refresh_token)
+ {
+ return $this->expireValue($this->config['refresh_token_key'] . $refresh_token);
+ }
+
+ /* AccessTokenInterface */
+ public function getAccessToken($access_token)
+ {
+ return $this->getValue($this->config['access_token_key'].$access_token);
+ }
+
+ public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
+ {
+ return $this->setValue(
+ $this->config['access_token_key'].$access_token,
+ compact('access_token', 'client_id', 'user_id', 'expires', 'scope'),
+ $expires
+ );
+ }
+
+ /*JWTBearerInterface */
+ public function getClientKey($client_id, $subject)
+ {
+ $jwt = $this->getValue($this->config['jwt_key'] . $client_id);
+ if ( isset($jwt['subject']) && $jwt['subject'] == $subject ) {
+ return $jwt['key'];
+ }
+ return null;
+ }
+}