保護されたAPI呼び出し
認証済みユーザだけが叩けるGET /notesエンドポイントを実装します。あわせて、発行したアクセストークンを検証する共通のミドルウェアも追加します。
1. helper.go の import 書き換え
トークン検証時のエラー生成に必要なerrorsパッケージを追加するため、helper.goのimportを以下のように書き換えます。前のimportにerrorsを追加した形です。
import (
"crypto/rand"
"encoding/hex"
"errors"
"time"
"github.com/golang-jwt/jwt/v5"
"golang.org/x/crypto/bcrypt"
)
errorsはトークン検証失敗時のエラー生成で使います。
2. アクセストークン検証ヘルパーの追加
サーバをいったんCtrl + Cで停止します。停止したら、helper.goの末尾(generateRefreshToken関数の下)に、JWTのアクセストークンを検証してユーザIDを取り出すヘルパーparseAccessTokenを追加します。
func parseAccessToken(tokenStr string) (uint, error) {
token, err := jwt.Parse(tokenStr, func(t *jwt.Token) (interface{}, error) {
if _, ok := t.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, errors.New("unexpected signing method")
}
return jwtSecret, nil
})
if err != nil || !token.Valid {
return 0, errors.New("invalid token")
}
claims, ok := token.Claims.(jwt.MapClaims)
if !ok {
return 0, errors.New("invalid claims")
}
sub, ok := claims["sub"].(float64)
if !ok {
return 0, errors.New("invalid sub")
}
return uint(sub), nil
}
コードを解説します。
func parseAccessToken(tokenStr string) (uint, error) {
parseAccessTokenのシグネチャです。JWT文字列を受け取り、検証に成功したらペイロードから取り出したユーザIDを返し、失敗すればエラーを返します。
token, err := jwt.Parse(tokenStr, func(t *jwt.Token) (interface{}, error) {
if _, ok := t.Method.(*jwt.SigningMethodHMAC); !ok {
return nil, errors.New("unexpected signing method")
}
return jwtSecret, nil
})
jwt.Parseは、トークン文字列と「署名検証に使う鍵を返すコールバック」を受け取ります。コールバック内でトークンの署名アルゴリズムを確認し、想定と異なるアルゴリズム(例: none)の場合はエラーで弾いています。これを省略すると、algフィールドを偽装したトークンを受け入れてしまう脆弱性につながります。想定どおりのHMAC系アルゴリズムであれば、パッケージレベルの秘密鍵jwtSecretを返して署名検証を進めます。
if err != nil || !token.Valid {
return 0, errors.New("invalid token")
}
jwt.Parse自体のエラー、またはtoken.Validがfalse(署名不一致・期限切れなど)の場合は、まとめて「無効トークン」として扱います。呼び出し元にどの理由で失敗したかは伝えず、抽象化したエラーだけを返します。
claims, ok := token.Claims.(jwt.MapClaims)
if !ok {
return 0, errors.New("invalid claims")
}
token.ClaimsはClaimsインタフェース型なので、こちらで指定したjwt.MapClaims(マップ型)に型アサーションで取り出します。想定外の型が入っていることは通常無いですが、防御的にチェックしています。
sub, ok := claims["sub"].(float64)
if !ok {
return 0, errors.New("invalid sub")
}
return uint(sub), nil
subにはユーザIDを入れていましたが、JSONの数値はfloat64としてデコードされます。取り出すときはfloat64で受け取ってから、目的の型(uint)に変換します。値が存在しない場合はエラーで返します。
3. 認証ミドルウェアの追加
続いて、認証ミドルウェアを配置するmiddleware.goを作成します。ミドルウェアは複数のハンドラの前後に挟む横断的な処理なので、helper.goやhandler.goとは分けて専用ファイルに置くと役割が明確になります。
Visual Studio Codeのエクスプローラーでjwt-auth-hands-onフォルダを右クリックし、「新しいファイル」を選択してmiddleware.goを作成します。
jwt-auth-hands-on/
├── .env
├── go.mod
├── go.sum
├── handler.go
├── helper.go
├── main.go
├── middleware.go ← このファイルを作成
└── model.go
作成したmiddleware.goに以下の内容を記述して保存します。Authorizationヘッダからトークンを取り出して検証するミドルウェアauthMiddlewareを定義しています。
package main
import (
"net/http"
"strings"
"github.com/gin-gonic/gin"
)
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
}
c.Set("userID", userID)
c.Next()
}
}
middleware.goも同じmainパッケージなので、helper.goのparseAccessTokenをそのまま呼び出せます。
コードを解説します。
func authMiddleware() gin.HandlerFunc {
return func(c *gin.Context) {
authMiddlewareはgin.HandlerFuncを返す関数です。ミドルウェアとしてr.Use(...)に渡すため、実際のハンドラは戻り値の無名関数として用意します。
header := c.GetHeader("Authorization")
if !strings.HasPrefix(header, "Bearer ") {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "Authorization ヘッダが必要です"})
return
}
tokenStr := strings.TrimPrefix(header, "Bearer ")
AuthorizationヘッダからBearer <トークン>形式で値を取り出します。Bearerは「Bearer認証(このトークンを持っている人=認証済み)」を示すスキーム名で、慣例的に用いられます。プレフィックスが無ければAbortWithStatusJSONで401 Unauthorizedを返し、以降のハンドラを実行させずに終了します。
userID, err := parseAccessToken(tokenStr)
if err != nil {
c.AbortWithStatusJSON(http.StatusUnauthorized, gin.H{"error": "トークンが無効です"})
return
}
先ほど定義したparseAccessTokenでトークンを検証し、失敗すればここも401 Unauthorizedで早期終了します。
c.Set("userID", userID)
c.Next()
トークン検証に成功したユーザIDをc.Setでgin.Contextに格納し、後続のハンドラでc.GetUint("userID")として参照できるようにしています。c.Next()で保護対象のハンドラに処理を渡します。
4. notes ハンドラの追加
handler.goの末尾(login関数の下)に、認証済みユーザのIDに紐づくノート一覧を返すnotesハンドラを追加します。ここではデモとして固定のノート一覧を返す形にしています。
func notes(c *gin.Context) {
userID := c.GetUint("userID")
items := []gin.H{
{"id": 1, "title": "買い物", "user_id": userID},
{"id": 2, "title": "打ち合わせ資料", "user_id": userID},
}
c.JSON(http.StatusOK, items)
}
続けて、main.goのmain関数のルート登録に、保護されたエンドポイントのグループを追加します。既存のr.POST("/login", login)の下に以下を追加します。
authorized := r.Group("/")
authorized.Use(authMiddleware())
{
authorized.GET("/notes", notes)
}
5. コードの解説
func notes(c *gin.Context) {
notesハンドラのシグネチャです。Ginの標準ハンドラ形式です。
userID := c.GetUint("userID")
authMiddlewareがc.Setで入れたuserIDを取り出します。c.GetUintはuint型で値を取り出すヘルパーです。ミドルウェアを通過している時点で必ず値は入っています。
items := []gin.H{
{"id": 1, "title": "買い物", "user_id": userID},
{"id": 2, "title": "打ち合わせ資料", "user_id": userID},
}
本章では認証の動作確認が主眼のため、DBからノートを取得する処理は入れず、固定のノート一覧を作って返します。実際のアプリケーションでは、userIDをキーにnotesテーブルから該当ユーザのレコードを取得する形になります。
c.JSON(http.StatusOK, items)
作ったノート一覧を200 OKのJSONで返します。認証ミドルウェアを通過したリクエストだけがここに到達するため、ユーザIDに応じた個別データを返す実装が安全に書けます。
authorized := r.Group("/")
authorized.Use(authMiddleware())
{
authorized.GET("/notes", notes)
}
Group("/")とUse(authMiddleware())の組み合わせで、認証を必要とするルート専用のグループを作ります。このグループに登録したエンドポイントは、すべてauthMiddlewareを通過してからハンドラが呼ばれます。波カッコの{ }はGoの構文としてはブロックスコープを作るだけですが、視覚的に「このグループに登録するルート一覧」を分かりやすく示すために使う書き方です。認証不要のルート(/signup・/login・/refresh・/logout)は、この外側に登録することで対象外にできます。
6. 動作確認
サーバを起動します。
go run .
まず、Authorizationヘッダを付けずに/notesを叩いて、401が返ることを確認します。
curl -i http://localhost:8080/notes
以下のような実行結果が表示されます。
HTTP/1.1 401 Unauthorized
...
{"error":"Authorization ヘッダが必要です"}
ミドルウェアが働き、Authorizationヘッダの無いリクエストが弾かれています。
次に、先ほど/loginで取得したアクセストークンをAuthorizationヘッダに付けて再度叩きます。トークンの値は自分のログイン結果に置き換えてください。
curl -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..." http://localhost:8080/notes
以下のような実行結果が表示されます。
[{"id":1,"title":"買い物","user_id":1},{"id":2,"title":"打ち合わせ資料","user_id":1}]
トークンが検証を通過し、c.Set("userID", userID)で埋め込まれたIDを使ってノート一覧が取得できています。認証済みユーザのみが叩けるエンドポイントの雛形ができました。
| ⚠️ トークンが「invalid token」で弾かれる場合 |
|---|
Authorization: Bearer 〜のスペース位置と、トークン文字列を最後まで正しくコピーできているかを確認してください。改行や末尾の空白が入っていると、parseAccessToken側で署名検証に失敗します。また、アクセストークンの有効期限は15分に設定しているため、時間が経ちすぎている場合は再度/loginを叩いて発行し直します。 |