
# CognitoとFastAPIで構築する認証API

## 目次
1. はじめに
2. AWS Cognitoとは
3. FastAPIの概要
4. 認証APIを構築するための具体的手順
    1. AWS Cognitoでの設定
    2. FastAPIプロジェクトのセットアップ
    3. Cognitoとの連携
    4. トークンの検証
    5. ユーザー登録とログイン
    6. カスタムルーティングと役割管理
5. まとめ

## 1. はじめに

認証はアプリケーション開発において不可欠な要素であり、適切な認証手段を用いることは情報の安全を保つために重要です。このガイドでは、AWSの認証サービスであるCognitoと、軽量かつ現代的なPythonのウェブフレームワークであるFastAPIを使用して、強力でスケーラブルな認証APIを構築する方法を紹介します。

## 2. AWS Cognitoとは

AWS Cognitoはスケーラブルなユーザープールを提供し、アプリケーションのユーザーベースを管理することができるサービスです。Cognitoを使用することで、安全かつ効率的にユーザー認証、認可、ユーザーデータの同期を実行することができます。

### AWS Cognitoの特徴

- **スケーラブルなユーザープール**: 数百万規模のユーザーを管理するのに適しています。
- **簡単な連携**: SNSログイン、SAMLプロバイダーとの統合が可能です。
- **セキュアなトークン発行**: OpenID Connect (OIDC)およびOAuth 2.0プロトコルをサポートします。

## 3. FastAPIの概要

FastAPIは、迅速な開発と高性能を両立するPythonのウェブフレームワークです。型ヒントを活用し、依存性注入を自然に使えることが特徴です。また、Swagger UIやRedocによる自動APIドキュメント化が可能で、開発効率の向上に寄与します。

### FastAPIの主な機能

- **ASGIサーバーの使用**: 非同期通信に対応。
- **自動ドキュメント生成**: 開発者に優しいUIを提供。
- **高性能**: ASGIとStarletteによる高速な動作。

## 4. 認証APIを構築するための具体的手順

ここからは、AWS CognitoとFastAPIを使った認証APIの構築法についての詳細な実装手順を紹介します。

### 4.1 AWS Cognitoでの設定

1. **Cognitoユーザープールの作成**
   - AWSコンソールにログインし、Cognitoサービスを選択します。
   - 新しいユーザープールを作成し、必要な設定（パスワードポリシーや認証フローなど）を行います。

2. **アプリクライアントの作成**
   - ユーザープールのアプリクライアントを設定し、シークレットなしで生成します。
   - 必要なOIDC構成を設定します。

3. **AWS IAMからポリシーの設定**
   - 必要なアクセス許可を設定したIAMロールを設定し、Cognitoへのアクセスを制限します。

### 4.2 FastAPIプロジェクトのセットアップ

開発環境を整え、FastAPIを活用したプロジェクトを初期化します。

![img](/mosaic-code.jpg)

設定ファイルの雛形を用意し、以後の開発に役立てます。

### 4.3 Cognitoとの連携

`boto3`を用いてCognitoのサービスクライアントを使用できるようにします。

![img](/mosaic-code.jpg)

### 4.4 トークンの検証

`python-jose`ライブラリを使用してJWTトークンを解析し、認証を行います。

![img](/mosaic-code.jpg)

### 4.5 ユーザー登録とログイン

FastAPIエンドポイントを定義し、ユーザーの登録とログインを管理します。

![img](/mosaic-code.jpg)

### 4.6 カスタムルーティングと役割管理

ロールベースのアクセス制御を追加し、より安全で役割に基づいたリソースへのアクセスを管理します。

![img](/mosaic-code.jpg)

## 5. まとめ

AWS CognitoとFastAPIを組み合わせた認証APIの構築は、堅牢でスケーラブルな認証システムを提供します。AWSの管理されたサービスを利用することで、開発者は本質的なビジネスロジックに集中でき、セキュリティリスクを最小限に抑えたアプリケーションを提供することが可能です。

具体的な実装例と統合の手順を加えれば、あらゆる規模のアプリケーションにスムーズに導入できるでしょう。[cv:issue_marketplace_engineer]


# CognitoとFastAPIで構築する認証API

## 目次
1. はじめに
2. AWS Cognitoとは
3. FastAPIの概要
4. 認証APIを構築するための具体的手順
    1. AWS Cognitoでの設定
    2. FastAPIプロジェクトのセットアップ
    3. Cognitoとの連携
    4. トークンの検証
    5. ユーザー登録とログイン
    6. カスタムルーティングと役割管理
5. まとめ

## 1. はじめに

認証はアプリケーション開発において不可欠な要素であり、適切な認証手段を用いることは情報の安全を保つために重要です。このガイドでは、AWSの認証サービスであるCognitoと、軽量かつ現代的なPythonのウェブフレームワークであるFastAPIを使用して、強力でスケーラブルな認証APIを構築する方法を紹介します。

## 2. AWS Cognitoとは

AWS Cognitoはスケーラブルなユーザープールを提供し、アプリケーションのユーザーベースを管理することができるサービスです。Cognitoを使用することで、安全かつ効率的にユーザー認証、認可、ユーザーデータの同期を実行することができます。

### AWS Cognitoの特徴

- **スケーラブルなユーザープール**: 数百万規模のユーザーを管理するのに適しています。
- **簡単な連携**: SNSログイン、SAMLプロバイダーとの統合が可能です。
- **セキュアなトークン発行**: OpenID Connect (OIDC)およびOAuth 2.0プロトコルをサポートします。

## 3. FastAPIの概要

FastAPIは、迅速な開発と高性能を両立するPythonのウェブフレームワークです。型ヒントを活用し、依存性注入を自然に使えることが特徴です。また、Swagger UIやRedocによる自動APIドキュメント化が可能で、開発効率の向上に寄与します。

### FastAPIの主な機能

- **ASGIサーバーの使用**: 非同期通信に対応。
- **自動ドキュメント生成**: 開発者に優しいUIを提供。
- **高性能**: ASGIとStarletteによる高速な動作。

## 4. 認証APIを構築するための具体的手順

ここからは、AWS CognitoとFastAPIを使った認証APIの構築法についての詳細な実装手順を紹介します。

### 4.1 AWS Cognitoでの設定

1. **Cognitoユーザープールの作成**
   - AWSコンソールにログインし、Cognitoサービスを選択します。
   - 新しいユーザープールを作成し、必要な設定（パスワードポリシーや認証フローなど）を行います。

2. **アプリクライアントの作成**
   - ユーザープールのアプリクライアントを設定し、シークレットなしで生成します。
   - 必要なOIDC構成を設定します。

3. **AWS IAMからポリシーの設定**
   - 必要なアクセス許可を設定したIAMロールを設定し、Cognitoへのアクセスを制限します。

### 4.2 FastAPIプロジェクトのセットアップ

開発環境を整え、FastAPIを活用したプロジェクトを初期化します。

```shell
$ mkdir fastapi-cognito-auth
$ cd fastapi-cognito-auth
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install fastapi uvicorn boto3 python-jose
```

設定ファイルの雛形を用意し、以後の開発に役立てます。

### 4.3 Cognitoとの連携

`boto3`を用いてCognitoのサービスクライアントを使用できるようにします。

```python
import boto3

# AWS Cognitoクライアントの初期化
cognito_client = boto3.client('cognito-idp', region_name='ap-northeast-1')

# ユーザーサインアップAPIの実行
response = cognito_client.sign_up(
    ClientId='CLIENT_ID',
    Username='testuser@example.com',
    Password='TestPassword123!',
    UserAttributes=[
        {
            'Name': 'email',
            'Value': 'testuser@example.com'
        },
    ]
)
```

### 4.4 トークンの検証

`python-jose`ライブラリを使用してJWTトークンを解析し、認証を行います。

```python
from jose import jwt, JWTError

def verify_jwt(token: str):
    try:
        # JWTの解析と検証
        payload = jwt.decode(token, 'your-public-key', algorithms=['RS256'])
        return payload
    except JWTError:
        raise HTTPException(status_code=401, detail="Invalid token")
```

### 4.5 ユーザー登録とログイン

FastAPIエンドポイントを定義し、ユーザーの登録とログインを管理します。

```python
from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.post("/signup")
async def sign_up_user(username: str, password: str, email: str):
    try:
        sign_up_response = cognito_client.sign_up(
            ClientId = 'YOUR_CLIENT_ID',
            Username = username,
            Password = password,
            UserAttributes=[
                {
                    'Name': 'email',
                    'Value': email
                },
            ]
        )
        return {"message": "Sign up successful", "userSub": sign_up_response['UserSub']}
    except Exception as e:
        raise HTTPException(status_code=400, detail=str(e))

@app.post("/login")
async def login_user(username: str, password: str):
    try:
        auth_response = cognito_client.initiate_auth(
            AuthFlow='USER_PASSWORD_AUTH',
            AuthParameters={
                'USERNAME': username,
                'PASSWORD': password
            },
            ClientId='YOUR_CLIENT_ID'
        )
        return {"access_token": auth_response['AuthenticationResult']['AccessToken']}
    except Exception as e:
        raise HTTPException(status_code=400, detail=str(e))
```

### 4.6 カスタムルーティングと役割管理

ロールベースのアクセス制御を追加し、より安全で役割に基づいたリソースへのアクセスを管理します。

```python
@app.get("/dashboard")
async def read_dashboard(token: str = Depends(oauth2_scheme)):
    payload = verify_jwt(token)
    if 'admin' in payload["cognito:groups"]:
        return {"message": "Welcome to the dashboard!"}
    else:
        raise HTTPException(status_code=403, detail="Not authorized to access this resource.")
```

## 5. まとめ

AWS CognitoとFastAPIを組み合わせた認証APIの構築は、堅牢でスケーラブルな認証システムを提供します。AWSの管理されたサービスを利用することで、開発者は本質的なビジネスロジックに集中でき、セキュリティリスクを最小限に抑えたアプリケーションを提供することが可能です。

具体的な実装例と統合の手順を加えれば、あらゆる規模のアプリケーションにスムーズに導入できるでしょう。

CognitoとFastAPIで構築する認証API

目次

続きを読むには単価診断を受けてください（30秒）