ログイン
ログインを行うPOST /loginエンドポイントを実装します。メールアドレスとパスワードを検証し、成功時にアクセストークン(JWT)とリフレッシュトークンを返す処理です。
1. helper.go の import 書き換え
このセクションで追加するトークン発行系ヘルパー群が使うパッケージを、まとめてhelper.goのimportに追加します。helper.goのimportを以下のように書き換えます。既存のbcryptはそのまま残し、time・crypto/rand・encoding/hex・golang-jwt/jwt/v5の4つを追加する形です。
import (
"crypto/rand"
"encoding/hex"
"time"
"github.com/golang-jwt/jwt/v5"
"golang.org/x/crypto/bcrypt"
)
timeは有効期限とトークン発行時刻の扱い、crypto/randとencoding/hexはリフレッシュトークンの乱数生成、golang-jwt/jwt/v5はJWTの発行で使います。この時点で追加したimportはまだ関数側で使っていないので、go run .を実行するとimported and not usedのコンパイルエラーが出ます。以降のヘルパー関数(定数追加・checkPassword・generateAccessToken・generateRefreshToken)まで追加し終えてから起動してください。
⚠️ no required module provides package github.com/golang-jwt/jwt/v5 と表示される場合 |
|---|
go.modにgolang-jwt/jwt/v5が登録されていません。プロジェクトの準備でgo get github.com/golang-jwt/jwt/v5を実行済みかを確認し、実行していない場合は以下のコマンドで追加してから、再度go run .を実行してください。 |
go get github.com/golang-jwt/jwt/v5
2. 有効期限の定数追加
サーバが動いていれば、いったんCtrl + Cで停止します。停止したら、helper.goの末尾(hashPassword関数の下)に、アクセストークンとリフレッシュトークンの有効期限をパッケージレベルの定数として追加します。
const (
accessTokenTTL = 15 * time.Minute
refreshTokenTTL = 30 * 24 * time.Hour
)
コードを解説します。
const (
accessTokenTTL = 15 * time.Minute
refreshTokenTTL = 30 * 24 * time.Hour
)
アクセストークンとリフレッシュトークンの有効期限を定数で定義します。アクセストークンは短命(15分)、リフレッシュトークンは長め(30日)にすることで、盗難時の影響と再ログイン頻度のバランスを取ります。time.Minuteとtime.Hourはtimeパッケージが提供する定数で、可読性の高い形で期間を表せます。
3. パスワード検証ヘルパーの追加
helper.goの末尾(先ほど追加した定数の下)に、DBに保存したパスワードハッシュと入力パスワードを照合するヘルパーを追加します。
func checkPassword(hash, password string) error {
return bcrypt.CompareHashAndPassword([]byte(hash), []byte(password))
}
コードを解説します。
func checkPassword(hash, password string) error {
checkPasswordの関数シグネチャです。DBに保存されているハッシュ文字列と、ログイン試行で受け取った平文パスワードの2つを受け取り、比較結果をエラーで返します。
return bcrypt.CompareHashAndPassword([]byte(hash), []byte(password))
bcrypt.CompareHashAndPasswordは、ハッシュと入力パスワードを照合する関数です。bcrypt側は[]byteを受け取るため[]byte()で変換して渡します。ハッシュ側にソルトが埋め込まれているため、呼び出し側でソルトを別途保持・受け渡しする必要はありません。一致すればnil、不一致ならbcrypt.ErrMismatchedHashAndPasswordが返ります。
4. アクセストークン発行ヘルパーの追加
helper.goの末尾(checkPassword関数の下)に、JWTのアクセストークンを発行するヘルパーを追加します。
func generateAccessToken(userID uint) (string, error) {
claims := jwt.MapClaims{
"sub": userID,
"exp": time.Now().Add(accessTokenTTL).Unix(),
"iat": time.Now().Unix(),
}
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
return token.SignedString(jwtSecret)
}
コードを解説します。
func generateAccessToken(userID uint) (string, error) {
generateAccessTokenの関数シグネチャです。ユーザIDを受け取り、そのユーザに紐づくJWT文字列とエラーを返します。
claims := jwt.MapClaims{
"sub": userID,
"exp": time.Now().Add(accessTokenTTL).Unix(),
"iat": time.Now().Unix(),
}
アクセストークンのペイロード(クレーム)を用意します。subにユーザID、expに有効期限(現在時刻+accessTokenTTL)、iatに発行時刻を入れます。expとiatはJWTの標準クレームで、Unix()でUNIX時刻の整数値として渡します。
token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
クレームと署名アルゴリズムを指定して*jwt.Tokenを用意します。SigningMethodHS256はHMAC-SHA256の共通鍵署名で、同じ秘密鍵を持っているサーバのみ、後から署名を検証できる方式です。
return token.SignedString(jwtSecret)
用意した*jwt.Tokenを、パッケージレベルで持っている秘密鍵jwtSecretで署名し、ヘッダ.ペイロード.署名の3パートをドットで連結したJWT文字列として返します。
5. リフレッシュトークン発行ヘルパーの追加
helper.goの末尾(generateAccessToken関数の下)に、リフレッシュトークンを生成してDBに保存するヘルパーを追加します。
func generateRefreshToken(userID uint) (string, error) {
b := make([]byte, 32)
if _, err := rand.Read(b); err != nil {
return "", err
}
tokenStr := hex.EncodeToString(b)
rt := RefreshToken{
UserID: userID,
Token: tokenStr,
ExpiresAt: time.Now().Add(refreshTokenTTL),
}
if err := db.Create(&rt).Error; err != nil {
return "", err
}
return tokenStr, nil
}
コードを解説します。
func generateRefreshToken(userID uint) (string, error) {
generateRefreshTokenの関数シグネチャです。アクセストークンと同じくユーザIDを受け取り、リフレッシュトークン文字列とエラーを返します。
b := make([]byte, 32)
if _, err := rand.Read(b); err != nil {
return "", err
}
crypto/randで32バイトの乱数を生成します。rand.ReadはOSが提供する暗号学的に安全な乱数源から値を取り出し、bに書き込みます。乱数取得に失敗するのはOS側の異常なので、そのままエラーとして呼び出し元に返します。
tokenStr := hex.EncodeToString(b)
生成した乱数バイト列を16進文字列にエンコードします。この文字列が、クライアントに渡すリフレッシュトークンの値になります。
rt := RefreshToken{
UserID: userID,
Token: tokenStr,
ExpiresAt: time.Now().Add(refreshTokenTTL),
}
if err := db.Create(&rt).Error; err != nil {
return "", err
}
return tokenStr, nil
トークン文字列・所有ユーザ・有効期限をRefreshTokenレコードとしてDBに保存し、成功時に生成した文字列を返します。JWTのように自己完結した情報をトークンに持たせず、DBに保存された値と一致するかで判定するため、失効管理をDB操作だけで完結できます。
6. login ハンドラの追加
handler.goの末尾(signup関数の下)に、以下のloginハンドラを追加します。
func login(c *gin.Context) {
var input struct {
Email string `json:"email" binding:"required"`
Password string `json:"password" binding:"required"`
}
if err := c.ShouldBindJSON(&input); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
var user User
if err := db.Where("email = ?", input.Email).First(&user).Error; err != nil {
c.JSON(http.StatusUnauthorized, gin.H{"error": "メールアドレスまたはパスワードが不正です"})
return
}
if err := checkPassword(user.PasswordHash, input.Password); err != nil {
c.JSON(http.StatusUnauthorized, gin.H{"error": "メールアドレスまたはパスワードが不正です"})
return
}
accessToken, err := generateAccessToken(user.ID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
refreshTokenStr, err := generateRefreshToken(user.ID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
c.JSON(http.StatusOK, gin.H{
"access_token": accessToken,
"refresh_token": refreshTokenStr,
})
}
続けて、main.goのmain関数のルート登録に、既存のr.POST("/signup", signup)の下に以下を追加します。
r.POST("/login", login)
7. コードの解説
func login(c *gin.Context) {
loginハンドラのシグネチャです。signupと同じくGinの標準ハンドラ形式で、*gin.Contextからリクエストとレスポンスを扱います。
var input struct {
Email string `json:"email" binding:"required"`
Password string `json:"password" binding:"required"`
}
if err := c.ShouldBindJSON(&input); err != nil {
c.JSON(http.StatusBadRequest, gin.H{"error": err.Error()})
return
}
リクエストボディを受け取る構造体を定義し、c.ShouldBindJSONでデコードとバリデーションを行います。signupと異なり、min=8やemail形式のチェックは付けません。ここでバリデーションで弾いてしまうと「登録済みのパスワードが短い(=古いユーザ)」ケースでログインできなくなるためです。
var user User
if err := db.Where("email = ?", input.Email).First(&user).Error; err != nil {
c.JSON(http.StatusUnauthorized, gin.H{"error": "メールアドレスまたはパスワードが不正です"})
return
}
入力されたメールアドレスでusersテーブルを検索します。Firstは該当行が無ければgorm.ErrRecordNotFoundを返します。ここではエラーの種類を区別せず、次のパスワード検証と同じメッセージを返して401 Unauthorizedで終了します。
if err := checkPassword(user.PasswordHash, input.Password); err != nil {
c.JSON(http.StatusUnauthorized, gin.H{"error": "メールアドレスまたはパスワードが不正です"})
return
}
先ほど作ったcheckPasswordで、DBに保存したハッシュと入力パスワードを照合します。不一致の場合も、上のユーザ検索失敗と同じメッセージ・同じステータスコードで返します。
c.JSON(http.StatusUnauthorized, gin.H{"error": "メールアドレスまたはパスワードが不正です"})
「ユーザが存在しない」場合と「パスワードが違う」場合の両方で、この共通メッセージを返しています。区別できるメッセージを返してしまうと、「そのメールアドレスがサービスに登録されているか」を第三者に推測されやすくなります。認証に関わる失敗は、原因を明示しないメッセージにそろえるのが基本です。
accessToken, err := generateAccessToken(user.ID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
パスワード検証を通過したユーザに対して、generateAccessTokenでJWTのアクセストークンを発行します。JWT署名の失敗はサーバ側の問題なので、500 Internal Server Errorで返します。
refreshTokenStr, err := generateRefreshToken(user.ID)
if err != nil {
c.JSON(http.StatusInternalServerError, gin.H{"error": err.Error()})
return
}
続けて、generateRefreshTokenでリフレッシュトークンを発行しつつ、そのトークンをDBに保存します。乱数生成やDB書き込みの失敗も、サーバ側の問題として500で返します。
c.JSON(http.StatusOK, gin.H{
"access_token": accessToken,
"refresh_token": refreshTokenStr,
})
200 OKでアクセストークンとリフレッシュトークンをJSONにまとめて返します。クライアントはこの2つを受け取り、以降のAPIリクエストではアクセストークンを、期限切れ時にはリフレッシュトークンを使います。
8. 動作確認
サーバを起動します。
go run .
先ほど作成したユーザでログインしてトークンを取得します。別のターミナルから以下を実行します。
curl -X POST http://localhost:8080/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はcrypto/randで生成した16進文字列です。次のセクションで、このアクセストークンをAuthorizationヘッダに載せて保護されたエンドポイントを叩きます。