ログアウト
ログアウトを行うPOST /logoutエンドポイントを実装します。JWTはステートレスな設計上、発行済みのアクセストークンをサーバ側から即時に無効化することは本来できません。「ログアウトしても、そのアクセストークンが有効期限まで生き残ってしまう」という状態は本来のログアウトの意図とかみ合わないため、DBにアクセストークンの無効化リスト(ブラックリスト)を持ち、認証ミドルウェアで照合する形で即時無効化を実現します。
本章のログアウトでは、以下の2つを同時に行います。
- アクセストークンを
revoked_access_tokensテーブルに登録し、認証ミドルウェアで拒否させる - リフレッシュトークンを
refresh_tokensテーブルのrevoked_atで失効させ、以降の/refreshを拒否させる
1. 無効化用モデルの追加
まず、失効させたアクセストークンを管理するモデルを追加します。JWTは自己完結型で、通常はサーバがDBに保存しません。ですが「そのトークンをブラックリスト入りにしたか」を判定するには、失効させたトークン文字列だけをDBに保管しておく必要があります。
model.goの末尾に、以下のRevokedAccessTokenモデルを追加します。
type RevokedAccessToken struct {
ID uint `gorm:"primaryKey" json:"-"`
Token string `gorm:"size:512;uniqueIndex;not null" json:"-"`
ExpiresAt time.Time `json:"-"`
RevokedAt time.Time `json:"-"`
}
続いて、main.goのAutoMigrate呼び出しに&RevokedAccessToken{}を追加します。
if err := db.AutoMigrate(&User{}, &RefreshToken{}, &RevokedAccessToken{}); err != nil {
log.Fatal("AutoMigrate失敗:", err)
}
コードを解説します。
Token string `gorm:"size:255;uniqueIndex;not null" json:"-"`
TokenにはJWTの文字列そのものを保管します。JWTはヘッダ.ペイロード.署名の3パートを連結した長めの文字列なので、size:512で十分な長さを確保します。uniqueIndexにより、同じトークンを重複登録しないよう制約をかけています。
ExpiresAt time.Time `json:"-"`
このトークンの有効期限(JWT側のexpと同じ値)を保存します。今回のハンズオンでは使いませんが、有効期限を過ぎたレコードは検証時に既に弾かれるため、バッチ処理で古いレコードを削除するためのカラムになります。
if err := db.AutoMigrate(&User{}, &RefreshToken{}, &RevokedAccessToken{}); err != nil {
AutoMigrateにRevokedAccessTokenを追加することで、次回のサーバ起動時にrevoked_access_tokensテーブルが自動作成されます。
2. 認証ミドルウェアへの無効化チェック追加
続いて、認証ミドルウェアに「アクセストークンがブラックリストに載っていないか」を確認する処理を追加します。middleware.goのauthMiddlewareを、以下のように書き換えます。
func authMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
header := c.GetHeader("Authorization")
if !strings.HasPrefix(header, "Bearer ") {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Authorization ヘッダが必要です"})
return
}
tokenStr := strings.TrimPrefix(header, "Bearer ")
userID, err := parseAccessToken(tokenStr)
if err != nil {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "トークンが無効です"})
return
}
var revoked RevokedAccessToken
if err := db.Where("token = ?", tokenStr).First(&revoked).Error; err == nil {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "トークンが無効化されています"})
return
}
c.Set("userID", userID)
c.Set("accessToken", tokenStr)
c.Next()
}
}
コードを解説します。
var revoked RevokedAccessToken
if err := db.Where("token = ?", tokenStr).First(&revoked).Error; err == nil {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "トークンが無効化されています"})
return
}
JWTの検証(署名・有効期限)を通過したあとに、revoked_access_tokensテーブルにそのトークンが登録されていないかを確認します。Firstがerr == nilで返るのは「レコードが見つかった」場合なので、その場合は無効化済みとして401 Unauthorizedで拒否します。gorm.ErrRecordNotFound(見つからなかった場合)はerr != nilとなり、そのまま通過します。
c.Set("accessToken", tokenStr)
userIDに加えて、アクセストークン文字列そのものもgin.Contextに格納しておきます。後述のlogoutハンドラで、このトークン文字列をブラックリストに登録するためです。
3. logout ハンドラの追加
サーバをいったんCtrl + Cで停止します。停止したら、handler.goの末尾(refresh関数の下)にlogoutハンドラを追加します。アクセストークンを検証してから無効化リストに登録する必要があるため、このハンドラは認証ミドルウェアを通過させます(後述のルート登録でauthorizedグループに入れます)。
func logout(c *gin.Context) {
var input struct {
RefreshToken string `json:"refresh_token" binding:"required"`
}
if err := c.ShouldBindJSON(&input); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
accessToken := c.GetString("accessToken")
revoked := RevokedAccessToken{
Token: accessToken,
ExpiresAt: time.Now().Add(accessTokenTTL),
RevokedAt: time.Now(),
}
if err := db.Create(&revoked).Error; err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
now := time.Now()
res := db.Model(&RefreshToken{}).
Where("token = ? AND revoked_at IS NULL", input.RefreshToken).
Update("revoked_at", now)
if res.Error != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": res.Error.Error()})
return
}
c.Status(http.StatusNoContent)
}
続けて、main.goのルート登録を書き換えてlogoutをauthorizedグループの中に入れます。既存のauthorizedグループの中にauthorized.POST("/logout", logout)を追加し、以前あったr.POST("/logout", logout)は削除します(初めて追加する場合は、単にauthorizedグループに追加するだけで問題ありません)。
authorized := r.Group("/")
authorized.Use(authMiddleware())
{
authorized.GET("/notes", notes)
authorized.POST("/logout", logout)
}
4. コードの解説
accessToken := c.GetString("accessToken")
先ほどauthMiddlewareがc.Set("accessToken", tokenStr)で入れておいたアクセストークン文字列を取り出します。認証ミドルウェアを通過している時点で、必ずこの値が入っています。
revoked := RevokedAccessToken{
Token: accessToken,
ExpiresAt: time.Now().Add(accessTokenTTL),
RevokedAt: time.Now(),
}
if err := db.Create(&revoked).Error; err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
取り出したアクセストークンをrevoked_access_tokensテーブルに登録します。以降このトークンで保護されたAPIを叩くと、authMiddlewareのブラックリスト照合で弾かれるようになります。認証ミドルウェアを通過したリクエストしかここに到達しないため、同じトークンが二重登録される心配はありません。
now := time.Now()
res := db.Model(&RefreshToken{}).
Where("token = ? AND revoked_at IS NULL", input.RefreshToken).
Update("revoked_at", now)
続けて、リクエストボディで受け取ったリフレッシュトークンをrefresh_tokensテーブルのrevoked_atで失効させます。revoked_at IS NULLの条件で、まだ失効していないレコードだけを対象にします。
c.Status(http.StatusNoContent)
ログアウトの成功時はレスポンスボディを持たず、204 No Contentだけを返します。この時点で、アクセストークンとリフレッシュトークンの両方がサーバ側から無効化されている状態になります。
5. 動作確認
サーバを起動します。
go run .
前のセクションで取得した最新のアクセストークン(eyJhbGci...)とリフレッシュトークン(a91b7e3d...)を/logoutに送り、両方を失効させます。アクセストークンはAuthorizationヘッダに、リフレッシュトークンはリクエストボディに載せます。
curl -i -X POST http://localhost:8080/logout \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." \
-H "Content-Type: application/json" \
-d '{"refresh_token":"a91b7e3d..."}'
以下のような実行結果が表示されます。
HTTP/1.1 204 No Content
204 No Contentが返り、アクセストークンはrevoked_access_tokensテーブルに登録され、リフレッシュトークンはrefresh_tokensテーブルのrevoked_atに時刻が入りました。
即時無効化が働いていることを確認するため、先ほどログアウトに使ったアクセストークンで、もう一度/notesを叩いてみます。
curl -i -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." http://localhost:8080/notes
以下のような実行結果が表示されます。
HTTP/1.1 401 Unauthorized
...
{"error":"トークンが無効化されています"}
アクセストークン自体はまだ有効期限内ですが、authMiddlewareのブラックリスト照合で拒否されました。JWTが本来持てなかった「即時無効化」を、DBのブラックリストで実現できていることが確認できます。
念のため、リフレッシュトークン側も無効化されていることを確認します。同じリフレッシュトークンで/refreshを叩くと、refresh token が失効していますで拒否されます。
curl -X POST http://localhost:8080/refresh -H "Content-Type: application/json" -d '{"refresh_token":"a91b7e3d..."}'
{"error":"refresh token が失効しています"}
アクセストークン・リフレッシュトークンの両方が無効化された状態になり、そのセッションからは新規のトークン発行もAPI呼び出しもできなくなりました。これで、DB管理方式による即時無効化を含めたログアウトの仕組みが一通り動くことが確認できます。
| 💡 ポイント |
|---|
revoked_access_tokensテーブルは、放置すると失効済みトークンのレコードが増え続けます。ExpiresAtを過ぎたレコードは有効期限側でどのみち弾かれるため、日次のバッチ処理などでExpiresAt < NOW()のレコードをDELETEする運用にすると、テーブルサイズを一定に保てます。本章では簡素化のためクリーンアップ処理は入れていません。 |