OAuth 2.0 直接認証 ¶

OAuth プロトコル 2.0 版では、追加のワークフローがいくつか利用可能であり、 OAuth プロバイダのウェブ・サイトを訪問する必要のない、直接認証が可能になっています。

Note: この節で説明されている認証ワークフローは、通常は、OAuth プロバイダによってサポートされていません。 なぜなら、通常の認証ワークフローより安全性が低いからです。 これらのワークフローを利用しようと試みる前に、あなたのプロバイダがそれをサポートしているかどうか、確認して下さい。

リソース・オーナー・パスワード・クレデンシャル・グラント ¶

リソース・オーナー・パスワード・クレデンシャル・グラント のワークフローは、OAuth プロバイダのウェブ・サイトにリダイレクトすることなく、ユーザ名/パスワードのペアによる直接のユーザ認証を可能にするものです。 (4.3. リソース・オーナー・パスワード・クレデンシャル・グラント を参照)

yii\authclient\OAuth2::authenticateUser() を使うと、このワークフローによってユーザを認証することが出来ます。 例えば、

$loginForm = new LoginForm();

if ($loginForm->load(Yii::$app->request->post()) && $loginForm->validate()) {
    /* @var $client \yii\authclient\OAuth2 */
    $client = Yii::$app->authClientCollection->getClient('someOAuth2');

    try {
        // ユーザ名とパスワードによる直接認証
        $accessToken = $client->authenticateUser($loginForm->username, $loginForm->password);
    } catch (\Exception $e) {
        // 認証の失敗。詳細は `$e->getMessage()` で取得
    }
    // ...
}

クライアント・クレデンシャル・グラント ¶

クライアント・クレデンシャル・グラント ワークフローは、OAuth クライアント (あなたのアプリケーション) のみを、 そのサードパーティ (実際のユーザ) とは無関係に認証するものです。 ユーザには関係のない、何らかの一般的な API にだけアクセス出来れば良いという場合に使います。

yii\authclient\OAuth2::authenticateClient() を使うと、このワークフローによってクライアントだけを認証することが出来ます。 例えば、

/* @var $client \yii\authclient\OAuth2 */
$client = Yii::$app->authClientCollection->getClient('someOAuth2');

// クライアントだけの直接認証
$accessToken = $client->authenticateClient();

JSON ウェブ・トークン (JWT) ¶

JSON ウェブ・トークン (JWT) のワークフロー によって JSON ウェブ・シグニチャ (JWS) を使った特定のアカウントの認証が可能になります。 次の例では、Google サービス・アカウント の認証を可能にしています。

use yii\authclient\clients\Google;
use yii\authclient\signature\RsaSha;

$oauthClient = new Google();

$accessToken = $oauthClient->authenticateUserJwt(
    'your-service-account-id@developer.gserviceaccount.com',
    [
        'class' => RsaSha::className(),
        'algorithm' => OPENSSL_ALGO_SHA256,
        'privateCertificate' => "-----BEGIN PRIVATE KEY-----   ...   -----END PRIVATE KEY-----\n"
    ]
);