ログイン
ログインを行うPOST /loginエンドポイントを実装します。メールアドレスとパスワードを検証し、成功時にアクセストークン(JWT)とリフレッシュトークンを返す処理です。
1. auth.py の書き換えとJWT発行ヘルパーの追加
auth.pyにJWT発行・パスワード検証などのヘルパー関数を追加します。冒頭のimportと定数、および関数群を含めて、以下の内容に書き換えます。既存のhash_passwordはそのまま残し、verify_password・generate_access_token・parse_access_token・generate_refresh_token・refresh_token_expires_atを追記した形です。
import os
import secrets
import time
from datetime import datetime, timedelta
import bcrypt
import jwt
ACCESS_TOKEN_TTL_SECONDS = 15 * 60
REFRESH_TOKEN_TTL_DAYS = 30
JWT_ALGORITHM = "HS256"
def get_jwt_secret() -> str:
secret = os.getenv("JWT_SECRET")
if not secret:
raise RuntimeError("JWT_SECRET が設定されていません")
return secret
def hash_password(password: str) -> str:
salt = bcrypt.gensalt()
return bcrypt.hashpw(password.encode("utf-8"), salt).decode("utf-8")
def verify_password(password: str, hashed: str) -> bool:
return bcrypt.checkpw(password.encode("utf-8"), hashed.encode("utf-8"))
def generate_access_token(user_id: int) -> str:
now = int(time.time())
payload = {
"sub": str(user_id),
"iat": now,
"exp": now + ACCESS_TOKEN_TTL_SECONDS,
}
return jwt.encode(payload, get_jwt_secret(), algorithm=JWT_ALGORITHM)
def parse_access_token(token: str) -> int:
payload = jwt.decode(token, get_jwt_secret(), algorithms=[JWT_ALGORITHM])
return int(payload["sub"])
def generate_refresh_token() -> str:
return secrets.token_hex(32)
def refresh_token_expires_at() -> datetime:
return datetime.utcnow() + timedelta(days=REFRESH_TOKEN_TTL_DAYS)
コードを解説します。
ACCESS_TOKEN_TTL_SECONDS = 15 * 60
REFRESH_TOKEN_TTL_DAYS = 30
JWT_ALGORITHM = "HS256"
アクセストークンとリフレッシュトークンの有効期限、および署名アルゴリズムを定数で定義します。アクセストークンは短命(15分)、リフレッシュトークンは長め(30日)にすることで、盗難時の影響と再ログイン頻度のバランスを取ります。
def get_jwt_secret() -> str:
secret = os.getenv("JWT_SECRET")
if not secret:
raise RuntimeError("JWT_SECRET が設定されていません")
return secret
JWTの署名鍵を環境変数JWT_SECRETから読み込むヘルパーです。ここをコードにハードコードすると、リポジトリを見られた時点でトークンの偽造が可能になるため、.envや本番環境の環境変数として外部から注入します。未設定時にRuntimeErrorで即座に停止させることで、鍵が空のまま起動してしまう事故を防ぎます。
def verify_password(password: str, hashed: str) -> bool:
return bcrypt.checkpw(password.encode("utf-8"), hashed.encode("utf-8"))
verify_passwordは、入力パスワードとDBに保存したハッシュをbcrypt.checkpwで照合する関数です。ハッシュ側にソルトが埋め込まれているため、呼び出し側でソルトを別途保持・受け渡しする必要はありません。
def generate_access_token(user_id: int) -> str:
now = int(time.time())
payload = {
"sub": str(user_id),
"iat": now,
"exp": now + ACCESS_TOKEN_TTL_SECONDS,
}
return jwt.encode(payload, get_jwt_secret(), algorithm=JWT_ALGORITHM)
generate_access_tokenは、JWTのアクセストークンを発行する関数です。subにユーザID、iatに発行時刻、expに有効期限を含めます。HS256はHMAC-SHA256の共通鍵署名で、JWT_SECRETを秘密鍵として署名します。同じ秘密鍵を持っているサーバのみ、後から署名を検証できます。
def parse_access_token(token: str) -> int:
payload = jwt.decode(token, get_jwt_secret(), algorithms=[JWT_ALGORITHM])
return int(payload["sub"])
parse_access_tokenはトークンの検証と復号を行う関数です。algorithms=[JWT_ALGORITHM]で許容する署名アルゴリズムを明示することで、algフィールドをnoneなどに偽装したトークンを弾けるようにしています。ここを省略してalgorithms=Noneにすると、署名検証をバイパスされる恐れがあります。
def generate_refresh_token() -> str:
return secrets.token_hex(32)
generate_refresh_tokenは、リフレッシュトークン文字列を生成する関数です。secrets.token_hexで生成した暗号学的乱数を16進文字列にしたものを使います。JWTのように自己完結した情報を持たせず、DBに保存された値と一致するかで判定するため、失効管理をDB操作だけで完結できます。
def refresh_token_expires_at() -> datetime:
return datetime.utcnow() + timedelta(days=REFRESH_TOKEN_TTL_DAYS)
リフレッシュトークンの有効期限(現在時刻+TTL日数)を計算するヘルパーです。ハンドラ側から呼び出してRefreshTokenレコードのexpires_atに入れる用途で使います。
2. handlers.py への login ハンドラの追加
handlers.pyのimportとrouter宣言を以下のように書き換えます。前のimportにLoginRequest・RefreshToken・TokenResponseのモデル、そしてauth.pyから新たにgenerate_access_token・generate_refresh_token・refresh_token_expires_at・verify_passwordを追加した形です。
from typing import Annotated
from fastapi import APIRouter, Depends, HTTPException, status
from sqlmodel import Session, select
from auth import (
generate_access_token,
generate_refresh_token,
hash_password,
refresh_token_expires_at,
verify_password,
)
from database import get_session
from models import (
LoginRequest,
RefreshToken,
SignupRequest,
TokenResponse,
User,
)
router = APIRouter()
続いて、handlers.pyの末尾(signup関数の下)に、リフレッシュトークン発行の共通ヘルパーissue_refresh_tokenとloginハンドラを追加します。
def issue_refresh_token(user_id: int, session: Session) -> str:
token = generate_refresh_token()
rt = RefreshToken(
user_id=user_id,
token=token,
expires_at=refresh_token_expires_at(),
)
session.add(rt)
session.commit()
return token
@router.post("/login", response_model=TokenResponse)
def login(
payload: LoginRequest,
session: Annotated[Session, Depends(get_session)],
):
user = session.exec(select(User).where(User.email == payload.email)).first()
if user is None or not verify_password(payload.password, user.password_hash):
raise HTTPException(status_code=401, detail="メールアドレスまたはパスワードが不正です")
return TokenResponse(
access_token=generate_access_token(user.id),
refresh_token=issue_refresh_token(user.id, session),
)
3. コードの解説
def issue_refresh_token(user_id: int, session: Session) -> str:
token = generate_refresh_token()
rt = RefreshToken(
user_id=user_id,
token=token,
expires_at=refresh_token_expires_at(),
)
session.add(rt)
session.commit()
return token
リフレッシュトークンをDBに保存する共通処理を関数として切り出しています。ログイン時とリフレッシュ時の両方から呼び出すため、重複を避けるためのヘルパーです。ハンドラ間で共有する処理はモジュールレベルの関数として切り出しておくと、責務の切り分けがしやすくなります。
@router.post("/login", response_model=TokenResponse)
def login(
payload: LoginRequest,
session: Annotated[Session, Depends(get_session)],
):
loginハンドラのシグネチャです。signupと同じく、payload: LoginRequestでリクエストボディを型付きで受け取り、Depends(get_session)でDBセッションを注入します。response_model=TokenResponseにより、レスポンスがTokenResponseスキーマにキャストされます。
user = session.exec(select(User).where(User.email == payload.email)).first()
if user is None or not verify_password(payload.password, user.password_hash):
raise HTTPException(status_code=401, detail="メールアドレスまたはパスワードが不正です")
入力されたメールアドレスでusersテーブルを検索し、見つかったUserのハッシュと入力パスワードをverify_passwordで照合します。「ユーザが存在しない」場合と「パスワードが違う」場合の両方で共通の401メッセージを返しています。区別できるメッセージを返してしまうと、「そのメールアドレスがサービスに登録されているか」を第三者に推測されやすくなります。認証に関わる失敗は、原因を明示しないメッセージにそろえるのが基本です。
return TokenResponse(
access_token=generate_access_token(user.id),
refresh_token=issue_refresh_token(user.id, session),
)
パスワード検証を通過したユーザに対して、generate_access_tokenでアクセストークンを、issue_refresh_tokenでリフレッシュトークンを発行してまとめて返します。クライアントはこの2つを受け取り、以降のAPIリクエストではアクセストークンを、期限切れ時にはリフレッシュトークンを使います。
4. 動作確認
uvicornは--reloadで動いているので、handlers.pyとauth.pyの保存で自動再起動されます。先ほど作成したユーザでログインしてトークンを取得します。別のターミナルから以下を実行します。
curl -X POST http://localhost:8000/login -H "Content-Type: application/json" -d '{"email":"test@example.com","password":"password12345"}'
以下のような実行結果が表示されます(トークンの値は環境により変わります)。
{"access_token":"eyJhbGciOiJIUzI1NiIs...","refresh_token":"3f4c8d2a6b..."}
access_tokenはJWT(.で3つに区切られた文字列)、refresh_tokenはsecrets.token_hexで生成した16進文字列です。次のセクションで、このアクセストークンをAuthorizationヘッダに載せて保護されたエンドポイントを叩きます。