Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
devise-two-factorを4.xから5.xに上げた話
Search
Kazuhiro NISHIYAMA
August 24, 2024
Technology
0
18
devise-two-factorを4.xから5.xに上げた話
[大阪Ruby会議04](
https://regional.rubykaigi.org/osaka04/)のスポンサーLTの発表資料です
。
Kazuhiro NISHIYAMA
August 24, 2024
Tweet
Share
More Decks by Kazuhiro NISHIYAMA
See All by Kazuhiro NISHIYAMA
docs.ruby-lang.org/ja/ の生成方法を変えた
znz
0
30
Ubuntuのriscv64版をqemuで動かした
znz
0
34
lilo.linux.or.jpをbusterからbullseyeに上げた
znz
0
43
小規模個人アプリをRails 7.xにバージョンアップした話
znz
0
26
Ruby リファレンスマニュアル改善計画 2022 進捗報告
znz
0
93
Rubyist Magazine Reboot
znz
0
100
History of Japanese Ruby reference manual, and future
znz
0
1.5k
qemuのriscv64にDebianを入れてみた
znz
0
95
systemd 再入門
znz
0
330
Other Decks in Technology
See All in Technology
20240912 JJUGナイトセミナー
mii1004
0
130
Javaにおける関数型プログラミンへの取り組み
skrb
7
300
JEP 480: Structured Concurrency
aya_ebata
0
120
サーバレスでモバイルアプリ開発! NTTコム「ビジネスdアプリ」のアーキテクチャ / The architecture of business d app
nttcom
12
220
四国のあのイベントの〇〇システムを45日間で構築した話 / cloudohenro2024_tachibana
biatunky
0
300
自社サービスのための独自リリース版Redmine「RedMica」の取り組み
vividtone
0
1.1k
Segment Anything Model 2
tenten0727
3
570
音声AIエージェントの世界とRetell AI入門 / Introduction to the World of Voice AI Agents and Retell AI
rkaga
4
900
効果的なオンコール対応と障害対応
ryuichi1208
5
2.6k
Zero Data Loss Autonomous Recovery Service サービス概要
oracle4engineer
PRO
0
3.2k
サーバー管理しないサーバーサービスManaged DevOps Pool
kkamegawa
0
100
AIで変わるテスト自動化:最新ツールの多様なアプローチ/ 20240910 Takahiro Kaneyama
shift_evolve
0
190
Featured
See All Featured
Become a Pro
speakerdeck
PRO
22
4.9k
Navigating Team Friction
lara
183
13k
Atom: Resistance is Futile
akmur
261
25k
Sharpening the Axe: The Primacy of Toolmaking
bcantrill
34
1.7k
The Art of Programming - Codeland 2020
erikaheidi
48
13k
Fontdeck: Realign not Redesign
paulrobertlloyd
80
5.1k
The Invisible Customer
myddelton
119
13k
How to name files
jennybc
75
98k
Producing Creativity
orderedlist
PRO
340
39k
Optimizing for Happiness
mojombo
375
69k
Debugging Ruby Performance
tmm1
72
12k
Into the Great Unknown - MozCon
thekraken
28
1.4k
Transcript
devise-two-factor を4.xから5.xに上 げた話 Kazuhiro NISHIYAMA 株式会社Ruby開発 大阪Ruby会議04 2024-08-24
self.introduction 西山 和広 Ruby のコミッター github など: @znz 株式会社Ruby開発 www.ruby-dev.jp
devise-two-factor とは? devise を TOTP の2要素認証に対 応するのに使う gem ユーザごとに以下のデータを保存 暗号化された
OTP シークレット (認証アプリに登録するもの) 使用済み OTP を区別できる情報 OTP が有効かどうか
4.x から 5.x への変更 下2個はそのままでいいが OTP シークレットの保存方法が変更 (再掲載) ユーザーごとに以下の データを保存
暗号化された OTP シークレット 使用済み OTP を区別できる情報 OTP が有効かどうか
4.x から 5.x への変更 4 は attr_encrypted gem encrypted_otp_secret, encrypted_otp_secret_iv,
encrypted_otp_secret_salt に Base64 でそれぞれ保存 5 は Rails 7+ 標準の encrypted attribute 暗号化したものを Base64 して JSON で otp_secret 1カラムに保存
更新手順 4 から 5 は Rails 6 から Rails 7
と同時に上げる必要あり https://github.com/devise-two-factor/ devise-two-factor/blob/main/ UPGRADING.md に手順あり ほとんど gem は複数の Rails に 対応していて独立して更新可能 今回はそうなっていない
なぜか? (推測) attr_encrypted gem と Rails 7 で #encrypted_attributes メ
ソッドが衝突する Rails 7 対応の attr_encrypted に 更新すると二度手間だから一気に 移行する手順になっている?
問題点 実運用環境なら Rails 7 に上げた 後に Rails 6 に戻す可能性もある のでは?
Rails 7 でユーザーの認証アプリと otp_secret だけが更新 → このまま Rails 6 に戻すと encrypted_* が古くて認証失敗 UPGRADING.md には戻す手順はない → 独自対応が必要
具体的には UPGRADING.md に legacy_otp_secret の実装例 公式の手順途中の動作 読み込み 新カラムが設定されていれば → otp_secret
なければ旧カラムを読む → legacy_otp_secret 書き込み は新しい otp_secret のみ
独自に書き込み対応 新しい otp_secret 書き込み時に legacy_otp_secret の逆手順で encrypted_* に同期 → legacy_otp_secret
でデコードした 結果が otp_secret と一致するのを確認 して自動テストも追加
手動ダウングレードテスト 実際に戻してみてテスト → うま く動かないので、さらに調査 → attr_encrypted が salt に
prefix と して _ をつける encode_salt オプショ ンがデフォルトで true Base64.decode64 は _ を無視する ので legacy_otp_secret は動く → 同期時に _ を prepend して解決
まとめ 非互換のダウングレード対応は新 バージョンでの互換メソッドの自 動テストだけでは不十分 手動でダウングレード確認も必須 その他の対応も場合分けして用意 例: ダウングレード中に encrypted_* だ
けが更新されて otp_secret が古くなる → otp_secret を nil に戻すタスク
宣伝 福岡Rubyist会議04 https:// regional.rubykaigi.org/fukuoka04/ 2024.09.07 Sat. 9:30–18:00 主催: Fukuoka.rb /
株式会社Ruby開発