AWS Cognito と認可コードフロー

Last updated at 2024-03-16Posted at 2024-03-16

Cognitoと認可コードフロー

認可コードフローを実装する機会がありました。そう言えば以前にCognitoをなんとなく触ったなーというのもあり、Cognitoの理解を深めるためにも、Cognitoで認可コードフローを試してみようと思い、その際の完全個人的メモ(途中)です。

Amazon Cognito はウェブアプリとモバイルアプリ用のアイデンティティプラットフォームです。これは、ユーザーディレクトリ、認証サーバー、OAuth 2.0 アクセストークンと AWS 認証情報の承認サービスです。Amazon Cognito を使用すると、組み込みのユーザーディレクトリ、エンタープライズディレクトリ、Google や Facebook などのコンシューマー ID プロバイダーからユーザーを認証および承認できます。

OIDC（OpenID Connect）

OAuth 2.0プロトコルに基づいた認証レイヤー
ユーザーの認証情報とID情報を安全に交換するための標準規格
OIDC IDプロバイダーは、このOpenID Connect規格を使用してユーザーの認証を行い、認証されたユーザー情報をアプリケーションやサービス（クライアント）に提供するシステムやサービス

IDプロバイダ（Identity Provider、略してIdP）

ユーザー認証とユーザーのデジタルアイデンティティ情報を管理するサービスまたはシステム
IDプロバイダは、ユーザーが誰であるか（身元）を証明し、
そのユーザーがアクセスを試みているサービスやアプリケーション（サービスプロバイダ）に対して、その証明を提供
このプロセスは、シングルサインオン（SSO）やフェデレーション認証の一環として頻繁に行われます

スコープ

aws.cognito.signin.user.admin
- Amazon Cognito ユーザープールをAPIで操作する

エンドポイント

/oauth2/authorize
- 認可エンドポイント
- ホストされたUI or IdPサインインページにリダイレクト
- https://docs.aws.amazon.com/cognito/latest/developerguide/authorization-endpoint.html
/login
- ログインエンドポイント
- https://docs.aws.amazon.com/cognito/latest/developerguide/hosted-UI-endpoints.html
/oauth2/token
- トークンエンドポイント
- 認可コード付与のリクエストを完了したユーザーがココードを付与しトークン縁dポイントにリクエストすると、ID、アクセス、およびリフレッシュトークンが返される
- https://docs.aws.amazon.com/cognito/latest/developerguide/token-endpoint.html
/auth2/userInfo
- トークンエンドポイントが発行したアクセストークンを渡すと、ユーザー属性を取得できる
- アクセストークンのスコープにより、userInfoエンドポイントが返すユーザー属性を定義する

流れ

①認可リクエスト(/oauth2/authorize)
https://kinoko-test-oauth.auth.ap-northeast-1.amazoncognito.com/oauth2/authorize?client_id=6rroupfknqnntpkoe94n3u0kan&response_type=code&scope=email+openid&redirect_uri=http://localhost:8080

認可リクエストを投げるとCognitoの場合は以下のログインエンドポイント(/login)にリダイレクトされる
https://kinoko-test-oauth.auth.ap-northeast-1.amazoncognito.com/login?client_id=6rroupfknqnntpkoe94n3u0kan&response_type=code&scope=email+openid&redirect_uri=https://localhost:8080

②認可サーバー（CognitoやGoogleなど）にサインイン
コールバックURIにリダイレクトされ、認可コードが発行される
https://localhost:8080/?code=ba359276-39af-4532-8729-43d579b5bca1

③認可コードをつけて、トークンエンドポイントへリクエスト
(/oauth2/token)

④アクセストークンが発行される

⑤リソースサーバーにアクセス

ユーザープールの作成

認証済みユーザー

外部プロバイダーとあるのが、Cognitoプール以外（フェデレーテッドアイデンティティプロバイダー）でサインインしたユーザーになります。

フェデレーテッドアイデンティティプロバイダーの設定

Cognitoの認証画面

{
  "data": {
    "sub": "18b43b25-b462-428d-b1d2-5bd56b897645",
    "email_verified": "true",
    "name": "ki",
    "email": "mashandroom.kinoko@gmail.com",
    "username": "kinoko2"
  }
}

ID プロバイダーにGoogleを指定してみた

GoogleのOAuth2で指定可能なスコープは以下の通りです。

GoogleのクライアントIDとクライアントシークレットを登録することで、CognitoからGoogle OAuthへ紐づけられるイメージですね。

IDプロバイダーにGoogleを追加することで、Google認証を選択できるようになります（ボタンが表示されます）。

以下の通り、SignIn画面にGoogleでのログインが追加されます。

Continue with Google を押すと以下にリクエストが投げられます。

https://kinoko-google-oauth.auth.ap-northeast-1.amazoncognito.com/login?client_id=5k5ihs3ucupfcbh17btapbffp2&response_type=code&scope=email+openid+profile&redirect_uri=http%3A%2F%2Flocalhost%3A3000%2Fauth


https://kinoko-google-oauth.auth.ap-northeast-1.amazoncognito.com/login	Cognitoログインエンドポイント
client_id	クライアントID
response_type	認可コードフロー
scope	email+openid+profile
redirect_uri	認可後のリダイレクト先

以下の設定をもとに、上記リクエストURIが生成されています。

属性マッピング

Googleの属性をCognitoのどの属性にマッピングするか？を指定します。

アクセエストークンを取得後、 /oauth2/userInfo にリクエストを投げユーザー情報を取得したものを見ると、マッピングした属性が含まれていることがわかります。

{
  "data": {
    "sub": "xxxxx",
    "identities": "[{\"userId\":\"zzzzzz\",\"providerName\":\"Google\",\"providerType\":\"Google\",\"issuer\":null,\"primary\":true,\"dateCreated\":1710586402334}]",
    "email_verified": "false",
    "name": "キノコ",
    "given_name": "キノコ",
    "family_name": "マッシュ&ルーム",
    "email": "mashandroom.kinoko@gmail.com",
    "username": "google_yyyyyyyy"
  }
}

コールバックを受けるバックエンド

①〜④は、Cognitoの設定（図）を参照し、変更してください。

Node.js

const express = require("express");
const axios = require("axios");
const querystring = require("querystring");

const app = express();
const port = 3000;

const cognitoClientId = ""; // ①
const cognitoClientSecret = ""; // ②
const redirectUri = "http://localhost:3000/auth"; // ③
const cognitoDomain = ""; // ④

app.get("/auth", async (req: any, res: any) => {
  const code = req.query.code;
  console.log(code);

  const authString = `${cognitoClientId}:${cognitoClientSecret}`;
  const authHeader = `Basic ${Buffer.from(authString).toString("base64")}`;

  try {
    const response = await axios.post(
      `https://${cognitoDomain}/oauth2/token`,
      querystring.stringify({
        grant_type: "authorization_code",
        client_id: cognitoClientId,
        redirect_uri: redirectUri,
        code: code,
      }),
      {
        headers: {
          "Content-Type": "application/x-www-form-urlencoded",
          Authorization: authHeader,
        },
      }
    );

    const accessToken = response.data.access_token;

    const userInfoResponse = await axios.get(
      `https://${cognitoDomain}/oauth2/userInfo`,
      {
        headers: {
          Authorization: `Bearer ${accessToken}`,
        },
      }
    );

    res.json({ data: userInfoResponse.data });
  } catch (error) {
    res.send("認証に失敗しました");
  }
});

app.listen(port, () => {
  console.log(`running on http://localhost:${port}.`);
});