Hướng dẫn php oauth 1.0 library - thư viện php oauth 1.0

oauth-php-lib

Thư viện này đã được triển khai từ các tài liệu chính thức để hiểu toàn bộ giao thức.

Nó chủ yếu nhằm mục đích sử dụng sư phạm và học tập.

Ví dụ

Chạy cài đặt trình soạn thảo để nhận được phụ thuộc và tự động tải:

Thiết lập máy chủ web của bạn để có 3 trang web trên 3 máy chủ riêng biệt:

• Máy chủ OAuth 1.0 của bạn: Ví dụ/OAuth2.0-server/
• Máy chủ OAuth 2.0 của bạn: Ví dụ/OAuth2.0-server/
• Khách hàng kiểm tra của bạn: Ví dụ/Khách hàng/

Trong tệp ví dụ/client/index.php, thay thế OAuth (1.0 | 2.0). Máy chủ lưu trữ bằng máy chủ máy chủ thực tế của bạn được tạo trước đó.

Đối với mục đích thử nghiệm, những ví dụ này đang sử dụng phiên làm lưu trữ dữ liệu không bao giờ được sử dụng trong sản xuất! Bạn có thể thay đổi các tệp trong các ví dụ/ src/ và tạo máy chủ và lưu trữ dữ liệu của riêng bạn dựa vào cơ sở dữ liệu.
You can change the files in examples/src/ and create your own server and data store relying on a database.

Người phục vụ

Để thiết lập một máy chủ, chỉ cần tạo một lớp con của OAuth2apiserver hoặc OAuth2Apiserver tùy thuộc vào phiên bản bạn dự định sử dụng.

Bạn sẽ phải triển khai lưu trữ dữ liệu trên cơ sở dữ liệu của riêng bạn để có được một máy chủ làm việc.

/**
 * OAuth 2.0 Server example 
 */

use DevSeb\OAuthPhpLib\OAuth\OAuthAccessToken;
use DevSeb\OAuthPhpLib\OAuth\OAuthConsumer;
use DevSeb\OAuthPhpLib\OAuth\OAuthRefreshToken;
use DevSeb\OAuthPhpLib\OAuth\OAuthRequestToken;
use DevSeb\OAuthPhpLib\OAuth\OAuthToken;
use DevSeb\OAuthPhpLib\Server\OAuth2ApiServer;
use DevSeb\OAuthPhpLib\Client\HttpRequest;

class MyOAuth2ApiServer extends OAuth2ApiServer
{
    public function __construct(HttpRequest $Request)
    {
        parent::__construct($Request);
    }
        
    //================================================================================================
    // OAuth2ApiServer implementation
    
    // TODO: implement Data Store

    protected function getConsumer($consumerKey){}
    protected function getConsumerFromToken($tokenKey){}
    protected function getToken(OAuthConsumer $Consumer, $tokenKey, $tokenType){}
    protected function newRequestToken(OAuthConsumer $Consumer, $redirectUri = ''){}
    protected function newAccessToken(OAuthConsumer $Consumer, OAuthRequestToken $RequestToken = null, OAuthRefreshToken $RefreshToken = null){}
    protected function newRefreshToken(OAuthConsumer $Consumer, OAuthAccessToken $RequestToken = null){}
    protected function showLoginPage(){}
    protected function authenticateUser(OAuthConsumer $Consumer, $username, $password){}    
    
}
?>

Khách hàng

Thư viện máy khách có thể được sử dụng với bất kỳ máy chủ OAuth nào. Trong ví dụ dưới đây, thay thế các giá trị giả của trường hợp trên:

/**
 * 3-legged OAuth 2.0 Client example
 */

use DevSeb\OAuthPhpLib\Client\OAuth2ApiClient;
use DevSeb\OAuthPhpLib\OAuth\OAuthRequest;
use DevSeb\OAuthPhpLib\OAuth\OAuthAccessToken;
use DevSeb\OAuthPhpLib\OAuth\OAuthRequestToken;
use DevSeb\OAuthPhpLib\OAuth\OAuthConsumer;

$Consumer = new OAuthConsumer('API_CONSUMER_KEY', 'API_CONSUMER_SECRET');

$Client = new OAuth2ApiClient('API_URL', $Consumer);

// Authenticate user
$Client->authenticate('AUTHENTICATION_CALLBACK_URL', 'scope', 'state');

// => redirect to authentication page
// ... authenticate 
// <= redirect to callback URL with code

// Get RequestToken
$requestToken = $_GET['code'];

// Get AccessToken and RefreshToken from RequestToken
$RequestToken = new OAuthRequestToken($requestToken);
list($AccessToken, $RefreshToken) = $Client->getAccessTokenFromAuthorizationCode($RequestToken);

// Call API using AccessToken
$Request = new OAuthRequest('API_URL');
$Response = $Client->getOAuthResponse($Request, $AccessToken);
var_dump($Response->getBody());

?>

Tài liệu

API PHP được ghi lại trong doc/index.html

Mô tả cơ bản về các luồng khác nhau tùy thuộc vào phiên bản OAuth và cách sử dụng như sau:

OAuth 1.0a

Tài liệu chính thức: https://oauth.net/core/1.0a/

1 chân OAuth 1.0a:

  Consumer                          Server
       1. Request access token
     |-------------------------------->|
       2. Issue an access token
     |<--------------------------------|
       3. Call protected API
     |-------------------------------->|
       4. Send response
     |<--------------------------------|

2 chân OAuth 1.0a:

  Consumer                          Server
       1. Request a token
     |-------------------------------->|
       2. Issue a request token
     |<--------------------------------|
       3. Request access token
     |-------------------------------->|
       4. Issue an access token
     |<--------------------------------|
       5. Call protected API
     |-------------------------------->|
       6. Send response
     |<--------------------------------|

3 chân OAuth 1.0a:

   Browser                 Consumer                    Server
                                 1. Request a token
                               |------------------------->|
                                 2. Issue a request token
                               |<-------------------------|
     3. Redirect to auth page
   |<--------------------------|
                  4. Grant access to consumer
   |----------------------------------------------------->|
                  5. Confirm user authorization
   |<-----------------------------------------------------|
     6. Redirect to callback
   |-------------------------->|
                                 7. Request access token
                               |------------------------->|
                                 8. Issue an access token
                               |<-------------------------|
                                 9. Call protected API
                               |------------------------->|
                                 10. Send response
                               |<-------------------------|

OAuth 2.0

Tài liệu chính thức: https://oauth.net/2/

OAuth 2 chân 2.0:

  Consumer                          Server
       1. Request access token
     |-------------------------------->|
       2. Issue an access token
     |<--------------------------------|
       3. Call protected API
     |-------------------------------->|
       4. Send response
     |<--------------------------------|

3 chân OAuth 2.0:

   Browser                 Consumer                    Server
      1. Redirect to auth page
   |<--------------------------|
                  2. Grant access to customer
   |----------------------------------------------------->|
                  3. Confirm user authorization
   |<-----------------------------------------------------|
     4. Redirect to callback
   |-------------------------->|
                                 5. Request access token
                               |------------------------->|
                                 6. Issue an access token
                               |<-------------------------|
                                 7. Call protected API
                               |------------------------->|
                                 8. Send response
                               |<-------------------------|