Share
Embed
Transcript
152 slides
-
自己紹介 • 奥寺政貴(おくでらまさたか) • 株式会社ビープラウド所属(2020〜) • 受託開発メイン • バックエンドエンジニア •
仕事でのDjango使用歴は約4年 • 趣味: インド料理の食べ歩き -
2つ以上のユーザー種別の要件の例 サービス ユーザー種別1 システムの使い方 ユーザー種別2 システムの使い方 ECサイト 販売者 • 商品登録
• 在庫変更 購入者 • カートに追加 • 購入 記事配信サイト ライター • 記事執筆 • 公開管理 購読者 • 記事にコメント • 有料記事の購入 ホテル予約サイト 事業者 • 予約管理 • 部屋情報の更新 宿泊者 • 予約 • キャンセル 2つ以上のユーザー種別 こういう要件がある時のDjangoでのユーザー認証の設計アプローチについて話す システムの使い方(≒ユー スケース)が大きく異なる -
ターゲット • ターゲット • Django中級者以上向け • 業務でDjangoを使っていて、設計も担当する人 • 想定している前提知識のレベル •
Djangoの基本(Model、View...)は理解してる • ざっくりとでもいいので、DjangoのUserモデルのカスタマイ ズ方法を理解している -
本発表の目的 • Djangoでの複数ユーザー種別認証の知見の体系化 • 巷で紹介されているパターン • 弊社内で実績があるパターン • → 議論や設計検討時の叩き台に使ってもらいたい
• ※ 逆にベストプラクティスの提示ではない -
話さないこと: 理由 端的にいうと私に知見がないから • 前提: 弊社は受託開発がメイン事業 • 0→1の新規開発や事業が軌道に乗りきる前のお客さんが多い • →
アーキテクチャは素早くユーザーに価値を提供できるモノリス を選択することが多い • サービス分割的な設計はお客さんの事業フェーズ的に選択肢に 入ってこないことが多い • ※ 直接ユーザーに価値を提供しない部分に時間を取られる • サービス間でデータやり取りする用のAPIの開発 • サービスを跨いだトランザクションの考慮 • etc... -
お品書き • 複数ユーザー種別の認証について考えることの重要性 • Djangoにおける複数ユーザー種別の認証 • 具体的な設計パターンの話 • 1.typeフィールドパターン •
2.認証モデル共有パターン • 3.認証モデル切り替えパターン • 4.独自実装パターン • 全体のまとめ 課題設定の話 -
【再掲】2つ以上のユーザー種別の例 • サービスの「提供者」と「受け手」という観点で改めて見てみ る サービス 提供者 システムの使い方 受け手 システムの使い方 ECサイト
販売者 • 商品登録 • 在庫変更 購入者 • カートに追加 • 購入 記事配信サイト ライター • 記事執筆 • 公開管理 購読者 • 記事にコメント • 有料記事の購入 ホテル予約サイト 事業者 • 予約管理 • 部屋情報の更新 宿泊者 • 予約 • キャンセル 提供者と受け手はシステムの使い方 (≒ユースケース)が大きく異なる -
複数ユーザー種別認証の設計について考 えることの重要性 • 回答: 「複数ユーザー種別の認証」という要件はWEBサービス 開発において再現性が高いので、設計パターンとして考えてお く価値がありそう • 再現性が高い理由: 「サービス」という言葉の定義からして、
そもそも「提供者」と「受け手」という2つのユーザー種別を 含んでいるから -
「Django」という文脈で複数ユーザー種 別の認証を議論する意義 Djangoはauth.Userモデルを前提とした認証の仕組みが存在する • メリット: 1つのユーザー種別かつID/パスワード認証であればサード パーティライブラリを使わずにセキュアな認証を簡単に実装できる • デメリット: 「複数ユーザー種別の認証」のような単純にDjangoの
レールに乗るだけでは実現できない要件が入ってくると制約にもな る → フレームワークの特性とどう付き合うかという観点が入ってくるの で「Django」という文脈で議論する意義がある -
紹介する設計パターン 1. typeフィールドパターン(非推奨) 2. 認証モデル共有パターン 3. 認証モデル切り替えパターン 4. 自前実装パターン ※
(参考)私の業務経験 • 2,4の設計で作られた本番稼働してるシステムにそれぞれ関わった経 験がある • 3は業務経験はないが社内でアイディアとしては時々聞くので PoC(Proof of Concept)を作って検証してみた -
題材とするWEBサービスの要件 サンプルコードを示したりする上で題材とするWEBサービスの要 件が必要 • 以下のような2つのユーザー種別を持つミニマムのECサイトを 想定 • 販売者(Merchant) • 購入者(Customer)
• それぞれのユーザー種別のみが可能な操作がある • 販売者: 商品登録 • 購入者: カートに追加 -
typeフィールドパターンの問題点 • ①モデルの制約によるデータ保護ができない • (例)merchant_employee_no( 従業員番号) • → 販売者の場合は必ず必要なフィールド •
→販売者と購入者でモデルを共有しているからフィール ドで必須制約がかけられない • merchant_employee_no = models.CharField("従業員番号", max_length=32, blank=True) • ②販売者/購入者それぞれに固有のフィールドを全てShopUserモ デルに持つことによるモデルの肥大化による保守性の低下を招 く -
認証モデル共有パターンの概要 • AUTH_USER_MODELに渡すモデル(=認証モデル)を2つ以上のユー ザーモデルで共有するパターン 認証モデル(= AUTH_USER_MODELに渡す) ER図イメージ customerとmechantは username/passwordを持たずに authenticationテーブルに外部化
※ auth_groups, auth_user_permissions などのDjango Admin用 のテーブルが紐づく -
やること 1. Authenticationモデルの定義 2. MerchantモデルとCustomerモデルの定義 3. 新規会員登録機能の実装 4. ログイン機能の実装 5.
[Option]独自ミドルウェアの実装 6. 独自LoginRequiredMixinの実装 -
Authenticationモデルの定義 • AbstractBaseUserを継承してAuthenticationという名前でモデル を定義する • → AuthenticationモデルをDjangoの認証モデルに設定する • AUTH_USER_MODEL =
"{アプリ名}.Authentication" • https://docs.djangoproject.com/ja/5.1/topics/auth/customizing/# substituting-a-custom-user-model -
②なぜAbstractUserではなく AbstractBaseUserを継承するのか • 前提知識: Djangoの組み込みのユーザーモデルは以下の継承関 係の上に成り立っている • AbstractBaseUser > AbstractUser
> User(デフォルト) • → 下の階層に行くほどDjango側で定義されているフィールドや メソッドが増える -
②なぜAbstractUserではなく AbstractBaseUserを継承するのか • ①のAuthenticationの命名の理由と関連する • 前提: Authenticationの責務は認証情報を持つことなので、でき るだけ関係のない情報は保持したくない(理想はログインIDとパ スワードだけ) •
→ AbstractUserはlast_nameとfirst_nameを保持している • → これらは認証とは関係がないのでAuthenticationには持たせた くない • (アカウント作成に氏名は不要とか逆にミドルネームも考慮 したいとかあるかもしれない) • → AbstractBaseUserを継承 -
新規会員登録Viewの実装 • UserManagerにcreate_user()という 便利メソッドがあるので使う • https://docs.djangoproject.com/j a/5.1/topics/auth/default/#creati ng-users • Autentication.usernameがDjangoの仕
様でユニークなので、重複を防ぐ ためにprefixをつけた方がいい • -> やらない場合「 販売者側で 使用済みのユーザー名を購入 者ユーザーが登録できない」 という事象が発生(仕様として 許容するかは要件次第) ②作成したAuthenticationを渡して Merchantを作成 ①Authentication を作成 -
ログインViewの実装 • authenticate()関数とlogin() 関数を使用 • https://docs.djangoproj ect.com/ja/5.1/topics/a uth/default/#how-to- log-a-user-in •
authenticate()関数に渡す ユーザー名にprefixをつけ る -
なぜ独自ミドルウェアを実装した方がい いのか? • Viewの中で毎回以下のようなコードを書くことになる • if request.user.is_authenticated and request.user.is_merchant: •
merchant = request.user.merchant • merchant.do_something() • → 処理の本質ではないコードを毎回書かないといけなくて無駄 なコスト & 可読性・保守性が下がる • → Viewに渡る前に共通処理にして見通しをよくしたい -
独自ミドルウェア実装 • AuthenticationのForeign Keyで取得 したユーザーモデルをrequestオ ブジェクトに詰めてあげる • Viewからは request.merchant.do_something() のように使える
• request.userはdelしてViewから参照できなく してしまうとよさそう(案件での実績なし) • 理由:コーディング規約で「request.userは使 わないこと」と書くより、コードレベルで参 照できなくした方が強制力が強い -
【補足】勝手にrequestにフィールド生や していいのか? • 結論: OK • そもそもdjnago.http.HttpRequestクラスにuserというフィールド は存在しない • Django本体のソースを読むと、AuthenticationMiddlewareの中
でrequestにuserフィールドを追加している • https://github.com/django/django/blob/main/django/contrib/au th/middleware.py -
【補足】Djangoがrequest.userを追加して いる仕組み • → Pythonは「クラス定義には存在しないフィールドでも、イン スタンス生成後に動的に追加が可能」という言語仕様を持って いる • https://docs.python.org/ja/3.11/tutorial/classes.html#instance- objects
• → この仕様を利用してRequestのクラス定義には存在しないuser フィールドを後から追加している -
独自LoginRequiredMixin実装 • LoginRequiredMixinのMerchantとCustomer版を作る • https://docs.djangoproject.com/ja/5.1/topics/auth/default/#the- loginrequiredmixin-mixin • ※ 関数ビューを使う場合はlogin_requiredデコレータのMerchant とCustomer版が必要
• https://docs.djangoproject.com/ja/5.1/topics/auth/default/#the- login-required-decorator -
退会機能って意外と難しい • 退会フラグは避けたい • 理由1: 退会フラグ = Falseをつけ忘れたら即重大なバグへ • 理由2:
個人情報がDB上に丸っと残るのでサービスによって は個人情報保護ポリシーなどに抵触する可能性がある • 全部物理削除 & FKにSET_NULLする方式だと情報の追跡可能性に 問題が出る • この商品登録したの誰だろう? • 退職した誰かっかっぽいけど分からないですね... • 物理削除する情報と残す情報を分けるのが理想 • → 削除する情報と残す情報の仕分けが難しい -
認証モデル共有パターンでは割ときれい に表現できる • 退会 = authenticationテーブルのレコード削除で表現できる • メリット1: 認証情報は物理削除するから、退会したユーザーが エンバグでログインできる余地がない
• メリット2: merchant、customerは残るので情報の追跡可能性は 維持できる -
メリット/デメリット • メリット • Djangoの認証機能を使える • 擬似的に複数種別のユーザーを表現しているだけで内部的に は1つの認証ユーザー • →
Djangoのレールに乗っているから安心 • カスタマイズ実装が必要な箇所はあるがそんなに難しくない • デメリット? • フレームワークの制約でDB設計が歪む • -> どういうことか次のスライドで説明 -
(補足)認証モデル共有パターンの別のア プローチ • Django中級者以上向けの有名な本である『Two Scoops of Django』の 著者の方が動画(2つで約30分)で紹介しているアプローチ • Multiple
User Types With Custom Data Fields | Django • https://youtu.be/f0hdXr2MOEA • Multiple User Types With Custom Data Fields | Django(続編) • https://youtu.be/V3zRZ6XRols • プロキシモデルを使用したアプローチ • https://docs.djangoproject.com/ja/5.1/topics/db/models/#proxy- models • この動画も観て本発表と比較してみると面白いと思います! -
生成されるテーブルのイメージ • 各ユーザーテーブ ルにusernameと passwordを持つ • →auththentication テーブル的なもの は不要 •
Django Admin用に はauth.Userをその まま使用 customer, merchant, auth_userの3ユーザー種別のテーブルが作成される -
やること 1. MerchantモデルとCustomerモデルの定義 2. 各環境にAUTH_USER_MODELを設定 3. 新規会員登録機能の実装 4. ログイン機能の実装 5.
Djangoのアプリを分ける 6. ユニットテスト 7. マイグレーション 本パターン特有のトピック -
【解説】なぜAbstractUserではないのか? • AbstractUserを継承した3つのユーザーモデルがGroup、 Permissionとそれぞれ関連を作成しようとしてrelated_name重複 エラーが起きる $ docker compose exec admin_app
python manage.py makemigrations SystemCheckError: System check identified some issues: ERRORS: auth.User.groups: (fields.E304) Reverse accessor 'Group.user_set' for 'auth.User.groups' clashes with reverse accessor for 'shop.Customer.groups'. HINT: Add or change a related_name argument to the definition for 'auth.User.groups' or 'shop.Customer.groups' (...省略) -
Djangoのアプリを分ける • 前提: 一般的な話としてDjangoのアプリは適切な粒度で分けたほ うがいい(tell-kさんのDjangoCongress JP 2022の発表を参照) • 『Djangoのアプリはどういう単位で作るべきか?』 •
https://tell-k.github.io/djangocongressjp2022/ • ただ特に「認証モデル切り替えパターン」では認証の主体にな るユーザー種別ごとにアプリを分けたほうがいい理由がある -
「認証の主体になるユーザー種別ごとに アプリを分けるとはどういうこと」か? merchant/views.py customer/views.py request.userが Merchant前提 のViewは merchantアプ リに定義 request.userが
Customer前提 のViewは customerアプ リに定義 -
request.userがどのユーザー種別を指している のかコードから読み取れないので見分けられ るものが必要 認証モデル共有パターン 認証モデル切り替えパターン ソースコードから 対象のユーザー種 別が分かる • コードを読んで
も、どのユー ザー種別を対象 にした処理か パッと分からな い • → Djangoアプリ の所属で判別で きるのがより重 要 -
ユニットテスト実行時の課題 • ユニットテストを実行するとその実行環境の AUTH_USER_MODELが使われる • → 全てのテストを一括実行した場合、前提とする AUTH_USER_MODELが異なるテストは全て失敗する • (例)
docker compose exec merchant_app python manage.py test を 実行 • → AUTH_USER_MODELがCustomer or auth.User前提のテストは 全て失敗 -
方法1: 全てのテストに@override_settings をつける • メリット • テスト実行が1コマンドで済む • デメリット •
毎回デコレータを付与するのが手間 • 環境変数が増えたときに全テストにデ コレータ追加する必要がある -
テスト実行をAUTH_USER_MODELの種別 ごとに分ける • AUTH_USER_MODELがMerchantモデル前提のテスト • docker compose exec merchant_app python
manage.py test merchant/ • AUTH_USER_MODELがCustomerモデル前提のテスト • docker compose exec customer_app python manage.py test customer/ • ※前提: AUTH_USER_MODELごとにテストケースがディレクトリ でグルーピングされている必要がある • → さっきのDjangoアプリを分けるのが大事という話と繋がる -
方法2: テスト実行をAUTH_USER_MODELの 種別ごとに分ける • メリット • デコレータの付与が不要 • デメリット •
全テスト実行する場合にコマンドを複数回実行する必要があ る • →全テスト実行はCIでやればいいから大きなデメリットではな いので、方法2の方がよさそう(私の意見) -
意図しないマイグレーション結果の例 • AUTH_USER_MODELがCustotmerモデルの状態で初回マイグレー ション適用してしまう • docker compose exec customer_app python
manage.py migrate • → customerテーブルにDjango Admin関連のテーブル群が関連し てしまう -
本当はこうしたかったはず • AUTH_USER_MODEL=auth.Userで初回マイグレーション適用する • docker compose exec admin_app python manage.py
migrate • → 期待通りauth_userテーブルにDjango Admin関連のテーブル群 が関連する -
一見メリットが多そうに見える • ユニットテストやマイグレーションで多少気をつけるべき点は ある • が、request.userをそのまま使えるので、全体的に「認証モデル 共有パターン」よりカスタマイズ実装する量が減っている • テーブル設計的にもmerchantとcustomerを完全に独立させられ ていてきれい(<->認証モデル共有パターンのDjangoの制約に引
きづられたauthenticationテーブル) • AUTH_USER_MODELで切り替えるのもカッコいい • → 「認証モデル共有パターン」も十分実用的なパターンだった がよりベターにみえる -
Django側が想定しているAUTH_USER_MODEL の使い方の範疇を超えている • AUTH_USER_MODELは自前でカスタマイズしたUserモデルを認 証モデルとして設定可能にするためのもの • → 1つのソースコードで環境ごとに認証ユーザーを切り替える 用途まではユースケースとして公式に書かれていない •
https://docs.djangoproject.com/ja/5.1/topics/auth/customizing/# substituting-a-custom-user-model • Django doesn't have multiple users. (Jazzband所属の人の回答) • https://stackoverflow.com/questions/25841712/django-best- approach-for-creating-multiple-type- users/25842236#25842236 -
自前実装パターンの概要 • django.contrib.authのソースコードを参考にして、認証機能を自 前実装する • Djangoが提供している関数は使う前提(≠完全なフルスクラッチ) • 例: make_password, session.cycle_key()など
• auth.UserはDjango Admin専用で使う(Django Adminは使うなら) -
そもそもセキュリティ観点で独自実装は 選択肢としてありなのか? • 回答: おすすめしない(後述)が論外と言えるほどではない • 例えば、IPAはセッション管理の仕組みの独自実装は推奨してい ない • 安全なウェブサイトの作り方
- 1.4 セッション管理の不備 • 但し、本パターンは本当にゼロから認証機能を自作するわけで はない • django.contrib.authのソースコードを参考にする • Djangoが提供している認証機能用の関数は使う -
メリット • Djangoの認証の仕組みから距離を取れる • → フレームワークへの依存を抑えていると言える? • Djangoの認証機能で対応できないセキュリティ要件にも対応で きる •
→ 今のところそういう要件に出会ったことがない -
自前実装することへの個人的な意見 • 前提: 私自身も自前実装された案件に関わった経験もある • 結論: → あんまりおすすめはしない • 以下のshimizukawaさんのメモに理由はだいたい書いてある
• https://scrapbox.io/shimizukawa/Djangoの認証を独自に実装し てはいけない -
私が考えるおすすめしない理由(初期開発 フェーズ) • django.contrib.authのソースコードを読み解く工数がかかる • → django.contrib.authはセキュリティ対策面で作り込まれて いるので、どこまで取り入れるかの判断で悩んで時間取られ そう •
参考にして実装する工数 & 実装過程でバグが混入するリスク • セキュリティテストを重点的にやる必要があるのでテスト工数 が増える -
私が考えるおすすめしない理由(プロジェ クト全体的な観点) • 認証機能はそれ自体がユーザーに価値を提供するものではない • → 特にサービスが軌道に乗るまでは色んな機能を作ってユー ザーのニーズを知るとかのほうが大事 • →
認証機能を自作するリソースで他の機能作ったり、サービス インの時期を早めたりした方がいいのでは? -
私が設計担当者ならどれから考えるか • まずは認証モデル共有パターンから考える • 多くのケースで特に不満はなさそう • 「1つの認証ユーザー」というDjangoのレールにも乗ってるので 安心 • 認証モデル切り替えパターン:
• ハック気味なパターン(主観)なので見えてないリスクがありそう で怖い • 認証モデル共有パターンと比較して得られるメリットを考えた時 に、リスクを冒すに値するほどのメリットはなさそう • 自前実装パターン: • 工数を割いたりセキュリティリスクを背負ったりしてまでやる価 値のあるケースは少なそう -
最後に • 本発表はベストプラクティスの提示ではない • Djangoの複数ユーザー認証の設計の議論の叩き台に便利に使っ てもらえたらうれしい • 以下のようなフィードバックもらえるとうれしいです • 各パターンに関して私が言及できてないメリット/デメリッ
ト • 業務でこのパターン使ったよ(感じたメリデメもあれば) • 他にこういうパターンもありそう • etc... • ありがとうございました! -
constant_time_compare関数 • constant_time_compare関数 • https://github.com/django/django/blob/main/django/utils/crypto .py • 文字列長によって文字列の比較の実行時間が異なることを利用 した攻撃があり、その対策のための文字列長に依存しない比較 関数らしい
• https://stackoverflow.com/questions/35910793/in-crypto- constant-time-compare-why-the-time-taken-is-independent-of- the-number -
一見意味のないハッシュ化: 理由 コードコメントに解説が書いてある • ユーザーが存在する場合だけハッシュ化すると、ハッシュ化す る分時間がかかるから処理速度(≒レスポンスタイム)に差が出る • → 攻撃者に「ユーザーが存在しない」というヒントを与えてし まうリスクがある
• → 対策でユーザーが存在しない場合もハッシュ化を実行してい る -
typeフィールドパターン • https://www.youtube.com/watch?v=V3zRZ6XRols • 『Multiple User Types With Custom Data
Fields | Django』 • Django中級者以上向けの有名な本である『Two Scoops of Django』の著者の方の動画 • 動画内では推奨しないパターンとして紹介されている • 4:30頃から -
認証モデル共有パターン • https://youtu.be/f0hdXr2MOEA • 『Multiple User Types | Django』 •
Django中級者以上向けの有名な本である『Two Scoops of Django』の著者の方の動画 • 続編: https://www.youtube.com/watch?v=V3zRZ6XRols • https://nwpct1.hatenablog.com/entry/django-auth-patterns • 『 Django における認証処理実装パターン』 • c-bataさんの記事 • ユーザーモデルのカスタマイズ方法や認証バックエンドの話 など勉強になる -
認証モデル共有パターン • https://speakerdeck.com/moro/identifying-user-idenity • 『Identifying User Idenity』 • Kaigi on
Rails 2024の発表 • usersテーブルとuser_credentialsテーブルを分ける設計や退会 の表現方法などのアイディアを参考にさせて頂いた -
認証モデル差し替えパターン • https://github.com/shimizukawa/django-multiple-type-user-auth • 弊社のshimizukawaさんの同パターンのPoC実装 • https://tell-k.github.io/djangocongressjp2022/ • 『Djangoのアプリはどういう単位で作るべきか?』 •
「5.Djangoのアプリを分ける」で言及した弊社tell-kさんの DjangoCongress JP 2022の発表 • https://stackoverflow.com/questions/25841712/django-best- approach-for-creating-multiple-type-users/25842236#25842236 • “django best approach for creating multiple type users”という質 問へのJazzband所属の人の回答 -
自前実装パターン • https://www.ipa.go.jp/security/vuln/websecurity/session- management.html • 『安全なウェブサイトの作り方 - 1.4 セッション管理の不備』 •
引用したIPAのドキュメント • https://scrapbox.io/shimizukawa/Djangoの認証を独自に実装してはいけ ない • shimizukawaさんがDjangoの認証を独自で実装すべきではないと考 えている理由のメモ • https://github.com/beproud/django-newauth • 弊社でDjangoの認証ライブラリの自作を試みたもの