🎄teratailクリスマスプレゼントキャンペーン2024🎄』開催中!

\teratail特別グッズやAmazonギフトカード最大2,000円分が当たる!/

詳細はこちら
Go

Go(golang)は、Googleで開発されたオープンソースのプログラミング言語です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

Q&A

解決済

1回答

3546閲覧

リクエストヘッダのx-tokenを読み取ってDBに保存してある認証トークンと照合するには?

BraveDragon

総合スコア15

Go

Go(golang)は、Googleで開発されたオープンソースのプログラミング言語です。

API

APIはApplication Programming Interfaceの略です。APIはプログラムにリクエストされるサービスがどのように動作するかを、デベロッパーが定めたものです。

0グッド

1クリップ

投稿2021/02/28 07:23

編集2021/03/01 00:49

前提・実現したいこと

Goを利用してWebAPI用のサーバーのプログラムを書いています。ユーザー作成の部分はできていて、ユーザー管理のためのUserテーブル(DB上)にユーザーID、ユーザー名、認証トークンを生成して保存するところまではできたのですが、そこから認証トークンと照合するにはどうすれば良いかが分かりません。
私としては、DBに保存してある認証トークンとリクエストヘッダ内のx-tokenと照合したいのですが、以下のことが分からず困っています。
0. 現在使用しているライブラリのgorilla/mux、gorilla/schemaを利用してリクエストヘッダ内のx-tokenを読み取る方法。
0. 認証トークンはDB内に保管してあるデータであり、ユーザー登録を行ったクライアントは認証トークンを持っていない可能性が高い。このような場合、どうやってクライアントとサーバーで認証トークンを同期すればよいのか。また、クライアントには何のデータを送信するよう要求すればよいのか。
0. 認証トークンには有効期限が設定されている。トークンの有効期限が切れた場合、更新しなければならないと思うのだが、更新の処理はどうすればよいのか。

発生している問題・エラーメッセージ

  • GoでWebAPI用のサーバーのプログラムを書いている。ライブラリにはgorilla/mux、gorilla/schemaを使用している。
  • DBに保存してある認証トークンとリクエストヘッダ内のx-tokenを照合したいのだが、以下のことがわからない。
  1. 現在使用しているライブラリのgorilla/mux、gorilla/schemaを利用してリクエストヘッダ内のx-tokenを読み取る方法。
  2. 認証トークンはDB内に保管してあるデータであり、ユーザー登録を行ったクライアントは認証トークンを持っていない可能性が高い。このような場合、どうやってクライアントとサーバーで認証トークンを同期すればよいのか。また、クライアントには何のデータを送信するよう要求すればよいのか。
  3. 認証トークンには有効期限が設定されている。トークンの有効期限が切れた場合、更新しなければならないと思うのだが、更新の処理はどうすればよいのか。
  • 上記の1. 2. 3.の問題を解決し、認証トークンとリクエストヘッダ内のx-tokenの照合処理を完成させたい。
  • トークンの生成方法は以下の通りとなる。
  1. 新規ユーザー登録時、ユーザー名をパスパラメーターから取得する。
  2. ユーザー名とは別に、ユーザーIDをUUIDで生成する。生成にはUUIDを扱うライブラリであるgoogle/uuidを使用する。
  3. トークンの有効期限を設定するため、現在の時刻を取得する。
  4. ユーザーIDをシードとして秘密鍵を生成。
  5. PASETOを扱うライブラリであるo1egl/pasetoを利用してPASETO用のトークンペイロードクレーム(token payload claim)を生成する。この時、トークンの有効期限を3.で取得した現在時刻から30分後までとする。
  6. footerに文字列"FOOTER"を設定する。
  7. 秘密鍵、トークンペイロードクレーム、footerを元に認証トークンを生成する。
  8. ユーザー情報を管理するDBのテーブルであるUserテーブルをマッピングした構造体UserにユーザーID、ユーザー名、認証トークンを格納し、それをDBに追加して反映させる。・
  • 以上の処理のソースコードは以下の通りとなる。

Go

1package main 2 3import ( 4 "database/sql" 5 "net/http" 6 7 "crypto/ed25519" 8 "encoding/hex" 9 "time" 10 11 "github.com/go-gorp/gorp" 12 "github.com/google/uuid" 13 "github.com/gorilla/mux" 14 "github.com/gorilla/schema" 15 "github.com/o1egl/paseto" 16) 17 18//User : ユーザー情報を管理 19type User struct { 20 id string `db:"ID, primarykey` //ユーザーID 21 name string `db:"name"` //ユーザー名 22 token string `db:"token"` //認証トークン 23 24} 25 26//DB に接続 27var DB, _ = sql.Open("mysql", "root:@APIDB") 28var DBMap = &gorp.DbMap{Db: DB, Dialect: gorp.MySQLDialect{"InnoDB", "UTF8"}} 29 30//ユーザー作成を行う 31func userCreate(w http.ResponseWriter, r *http.Request) { 32 //パスパラメーターから新規ユーザー名を取得 33 value := mux.Vars(r) 34 w.WriteHeader(http.StatusOK) 35 36 //IDはUUIDで生成 37 UUID, _ := uuid.NewUUID() 38 39 now := time.Now() 40 //ここから認証トークン生成部 41 //ユーザーIDから秘密鍵生成用のシードを生成 42 b, _ := hex.DecodeString(newUser.id) 43 privateKey := ed25519.PrivateKey(b) 44 jsonToken := paseto.JSONToken{ 45 Audience: "Audience", 46 Issuer: "Issuer", 47 Subject: "WebAPI", 48 Jti: "UUID", 49 Expiration: time.Now().Add(30 * time.Minute), 50 IssuedAt: now, 51 NotBefore: now, 52 } 53 54 jsonToken.Set("KEY", "VALUE") 55 footer := "FOOTER" 56 tokenCreator := paseto.NewV2() 57 //トークンを生成 58 token, _ := tokenCreator.Sign(privateKey, jsonToken, footer) 59 60 //新規ユーザー 61 newUser := User{} 62 newUser.name = value["name"] 63 newUser.id = UUID.String() 64 newUser.token = token 65 //DBに追加+反映 66 dbHandler, _ := DBMap.Begin() 67 dbHandler.Insert(newUser) 68 dbHandler.Commit() 69 70}

試したこと

以下のサイトを参考にすることで、認証トークンの作り方やgorillaの使い方はだいたい分かりましたが、現在私がやろうとしていることのやり方が分かりません。
goで作るAPIのセキュリティを考えた - Qiita
【Go×WAF】うほうほ!!gorillaを分かりやすくまとめてみた【mux/context/schema】 - Qiita

補足情報(FW/ツールのバージョンなど)

Goのバージョン:1.16
gorilla/muxのバージョン:1.8.0
gorilla/schemaのバージョン:1.2.0
使用しているDB:MySQL 8.0

気になる質問をクリップする

クリップした質問は、後からいつでもMYページで確認できます。

またクリップした質問に回答があった際、通知やメールを受け取ることができます。

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

nobonobo

2021/02/28 11:25

どういった規約のトークンを生成したのか具体的に書かれていないので具体的な回答はかなり困難です。一般論としての情報はリンク先の情報で十分かと。
BraveDragon

2021/03/01 00:50

トークンの生成方法について、情報を追記いたしました。
guest

回答1

0

ベストアンサー

JWT認証の基本的な流れは以下のサイトが参考になると思います。

https://techblog.roxx.co.jp/entry/2019/03/13/135739

JWT認証について理解を深めてもう少し具体的な実装をやってみることをお勧めします。

ざっくりした流れは以下の4点。
(以下のフローはHTTPS通信で第三者に漏洩しない状態であることが必須条件です。)

  1. ログイン時、ユーザーIDに紐づけて生成したトークンをクライアント(フロント)に送り、
  2. クライアントはそのトークンを保存しておき、API呼び出しのヘッダにトークンを載せてアクセス。
  3. サーバーはヘッダにあるトークンが本物かどうかを検証する。
  4. 有効なトークンでリフレッシュAPIに要求が来たら有効期限をのばしたトークンを生成し直してクライアントに返す。

現状上げていただいた実装についてアドバイスできることは以下の様な内容です。

  • サインアップをどうするかは考えておきましょう。

  • userCreate処理はHTTPハンドラとして実装しないで独立した処理にしてサインアップ処理で使う様にしましょう。

  • その上でログインとトークンリフレッシュ用のHTTPハンドラを実装しましょう

  • DBに保存するのはトークンそのものではなく、プライベートキーにしましょう。(そうしないと2度と正しいトークンを生成できませんのでリフレッシュもできません)

  • APIで認証情報を検証するには、サインアップ処理でクライアントに返したトークンがAPIリクエストヘッダーのAuthorizationヘッダに載ってるものを「Authorization: Bearer v2.public.eyJkYXRhIjoidGhpcyBpcyBhIHNpZ25lZCBtZXNzYWdlIiwiZXhwIjoiMjAxOC0wMy0xMlQxOTowODo1NCswMTowMCJ9Ojv0uXlUNXSFhR88KXb568LheLRdeGy2oILR3uyOM_-b7r7i_fX8aljFYUiF-MRr5IRHMBcWPtM0fmn9SOd6Aw.c29tZSBmb290ZXI」のようなBearer以降の文字列をpaseto.Verifyに引き渡すと検証できます。

  • サインアップの際の生成トークンを保存するのは基本フロント側実装の責務です。

  • Authorizationヘッダにトークンを載せるのはフロント側実装の責務です。

  • トークンのリフレッシュする判断や要求もフロント側実装の責務が一般的です。

  • つまり、JWT認証の話をする時、フロント側実装もセットで考える必要があります。

たまたま上記を実装してみた人がいたので追記

JWTが一般の実装でpasetoではありませんが、実装すべき最小限のコードと解説記事へのリンクがあります参考に。

https://github.com/miguelabate/jwt-go-mabate

投稿2021/03/01 02:53

編集2021/03/03 13:36
nobonobo

総合スコア3367

バッドをするには、ログインかつ

こちらの条件を満たす必要があります。

BraveDragon

2021/03/01 10:33

回答してくださり、誠にありがとうございました。 頑張ってみます。
BraveDragon

2021/03/04 00:41

実装の解説記事のリンクまで教えてくださり、誠にありがとうございました。 完成させられるよう、私も努力いたしますのでよろしくお願いいたします。
guest

あなたの回答

tips

太字

斜体

打ち消し線

見出し

引用テキストの挿入

コードの挿入

リンクの挿入

リストの挿入

番号リストの挿入

表の挿入

水平線の挿入

プレビュー

15分調べてもわからないことは
teratailで質問しよう!

ただいまの回答率
85.36%

質問をまとめることで
思考を整理して素早く解決

テンプレート機能で
簡単に質問をまとめる

質問する

関連した質問