如何使用Hyperf框架進行身份認證

如何使用Hyperf框架進行身份認證

在現代的網路應用程式中，使用者認證是一個非常重要的功能。為了保護敏感資訊和確保應用程式的安全性，身份認證可以確保只有經過驗證的使用者才能存取受限資源。

Hyperf是一個基於Swoole的高效能PHP框架，提供了許多現代化和高效的功能和工具。在Hyperf框架中，我們可以使用多種方法來實現身分認證，以下將介紹其中兩種常用的方法。

1. 使用JWT（JSON Web Token）

JWT是一種開放式標準（RFC 7519），它定義了一個簡潔的、自包含的方法，用於在通訊雙方之間安全地傳輸訊息。在Hyperf框架中，我們可以使用lcobucci/jwt擴充函式庫來實作JWT的產生與驗證。

首先，我們需要在composer.json檔案中加入lcobucci/jwt庫的依賴項：

"require": {
    "lcobucci/jwt": "^3.4"
}

然後執行composer update指令安裝依賴項。

接下來，我們可以建立一個JwtAuthenticator類，用於產生和驗證JWT：

<?php

declare(strict_types=1);

namespace AppAuth;

use HyperfExtAuthAuthenticatable;
use HyperfExtAuthContractsAuthenticatorInterface;
use LcobucciJWTConfiguration;
use LcobucciJWTToken;

class JwtAuthenticator implements AuthenticatorInterface
{
    private Configuration $configuration;

    public function __construct(Configuration $configuration)
    {
        $this->configuration = $configuration;
    }

    public function validateToken(string $token): bool
    {
        $parsedToken = $this->configuration->parser()->parse($token);
        $isVerified = $this->configuration->validator()->validate($parsedToken, ...$this->configuration->validationConstraints());
        
        return $isVerified;
    }

    public function generateToken(Authenticatable $user): string
    {
        $builder = $this->configuration->createBuilder();
        $builder->issuedBy('your_issuer')
            ->issuedAt(new DateTimeImmutable())
            ->expiresAt((new DateTimeImmutable())->modify('+1 hour'))
            ->withClaim('sub', (string) $user->getAuthIdentifier());
        
        $token = $builder->getToken($this->configuration->signer(), $this->configuration->signingKey());
        
        return $token->toString();
    }
}

然後，我們需要在Hyperf框架的容器中註冊 JwtAuthenticator類別：

HyperfUtilsApplicationContext::getContainer()->define(AppAuthJwtAuthenticator::class, function (PsrContainerContainerInterface $container) {
    $configuration = LcobucciJWTConfiguration::forAsymmetricSigner(
        new LcobucciJWTSignerRsaSha256(),
        LcobucciJWTSignerKeyLocalFileReference::file('path/to/private/key.pem')
    );

    return new AppAuthJwtAuthenticator($configuration);
});

最後，在需要認證的路由或控制器方法中，我們可以使用JwtAuthenticator類別來驗證使用者的JWT：

<?php

declare(strict_types=1);

namespace AppController;

use AppAuthJwtAuthenticator;
use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;

/**
 * @Controller(prefix="/api")
 */
class ApiController
{
    private JwtAuthenticator $authenticator;

    public function __construct(JwtAuthenticator $authenticator)
    {
        $this->authenticator = $authenticator;
    }

    /**
     * @RequestMapping(path="profile", methods="GET")
     */
    public function profile()
    {
        $token = $this->request->getHeader('Authorization')[0] ?? '';
        $token = str_replace('Bearer ', '', $token);
        
        if (!$this->authenticator->validateToken($token)) {
            // Token验证失败，返回错误响应
            return 'Unauthorized';
        }

        // Token验证成功，返回用户信息
        return $this->authenticator->getUserByToken($token);
    }
}

2. 使用Session

除了JWT認證，Hyperf框架也支援使用Session進行身份認證。我們可以透過設定檔來啟用Session認證功能。

首先，我們需要在設定檔config/autoload/session.php中進行對應的配置，例如：

return [
    'handler' => [
        'class' => HyperfRedisSessionHandler::class,
        'options' => [
            'pool' => 'default',
        ],
    ],
];

然後，在需要認證的路由或控制在器方法中，我們可以使用Hyperf框架提供的AuthManager類別來驗證使用者的Session：

<?php

declare(strict_types=1);

namespace AppController;

use HyperfHttpServerAnnotationController;
use HyperfHttpServerAnnotationRequestMapping;
use HyperfExtAuthContractsAuthManagerInterface;

/**
 * @Controller(prefix="/api")
 */
class ApiController
{
    private AuthManagerInterface $authManager;

    public function __construct(AuthManagerInterface $authManager)
    {
        $this->authManager = $authManager;
    }

    /**
     * @RequestMapping(path="profile", methods="GET")
     */
    public function profile()
    {
        if (!$this->authManager->check()) {
            // 用户未登录，返回错误响应
            return 'Unauthorized';
        }

        // 用户已登录，返回用户信息
        return $this->authManager->user();
    }
}

在上述程式碼中，AuthManagerInterface介面提供了許多用於認證和使用者操作的方法，具體可根據實際需求進行呼叫。

以上是使用Hyperf框架進行身份認證的兩種常用方法，透過JWT或Session來實現使用者驗證。根據實際需求和專案特點，選擇合適的方法以確保應用程式的安全性和使用者體驗。在實際開發中，可以根據框架提供的文件和範例程式碼深入了解更多進階用法和最佳實踐。

以上是如何使用Hyperf框架進行身份認證的詳細內容。更多資訊請關注PHP中文網其他相關文章！