GraphQLを安全に使うためにやっていること

by 林憲吾

Slide 1

Slide 1 text

GraphQLを安全に使うためにやっていること株式会社PICK 重本太宏

Slide 2

Slide 2 text

重本太宏 / Takahiro Shigemoto 自己紹介 Web Engineer at PICK BE : FE = 7 : 3 設計が好きお気に入りはオニオンアーキ × DDD × テスト駆動

Slide 3

Slide 3 text

GraphQLの利点利便性がもたらすリスク 01. PICKで行っている対策 02. 03. 目次まとめ 04.

Slide 4

Slide 4 text

01. GraphQLの利点

Slide 5

Slide 5 text

GraphQLの利点 01. GraphQLの利点 • いちいちエンドポイントを考える必要がない。増えない。 • 型でFEとBEが語り合える • FEでレスポンスを型安全に扱うことができる • 一つのクエリで様々なデータフェッチに対応することができる • オーバーフェッチを考慮しなくていいので、 API実装側はYAGNIをあまり気にせず実装可能

Slide 6

Slide 6 text

GraphQLの柔軟性の理由 01. GraphQLの利点 A. GraphQLは「型というノードがグラフで繋がれた世界にアクセスするためのクエリ言語」だから • SQLに近い • リレーションさえしていれば（エッジで繋がってさえいれば）縦横無尽にフィールドを取得することができる

Slide 7

Slide 7 text

01. GraphQLの柔軟性の理由 GraphQLの利点 Compa ny Team Contrac t User

Slide 8

Slide 8 text

02. 利便性がもたらすリスク

Slide 9

Slide 9 text

利便性がもたらすリスク 02. 利便性がもたらすリスク • どこからでも引っ張ってこれることによる、意図しないフィールド露出 • 複雑なクエリや深いクエリを呼ばれることによる DoS攻撃リスク取ろうと思えばフィールドを取れすぎるのが元凶

Slide 10

Slide 10 text

03. PICKで行っている対策

Slide 11

Slide 11 text

フィールド露出対策 03. PICKで行っている対策 • 敢えて有向グラフにする • フィールドに認可機能を入れる

Slide 12

Slide 12 text

フィールド露出対策 03. PICKで行っている対策あえて有向グラフにする • 有向にすることで意図しないフィールド露出を抑制できる • メリット • 簡単にできる • デメリット • 利便性が下がる • 把握が難しい Compa ny Team Contrac t User

Slide 13

Slide 13 text

フィールド露出対策 03. PICKで行っている対策フィールドに認可機能を入れる • NestJSが提供している FieldMiddlewareを利用 • フィールドを解決する前後に処理を追加してくれる機能を利用する • PICKではResolver関数の認可を Guardで行い、フィールドの認可を FieldMiddlewareで行っている

Slide 14

Slide 14 text

フィールド露出対策 03. PICKで行っている対策フィールドに認可機能を入れる 1. Resolverの引数に入る Contextに必要な情報を入れる 2. FieldMiddlewareを定義する 3. フィールドに適用する

Slide 15

Slide 15 text

フィールド露出対策 03. PICKで行っている対策

Slide 16

Slide 16 text

DoS攻撃対策 03. PICKで行っている対策 • 同時にいくつものクエリを叩ける • 深く取得しようと思えばいくらでもいける GraphQLはQueryによってサーバーに過剰なストレスを与えることができる

Slide 17

Slide 17 text

DoS攻撃対策 03. PICKで行っている対策 • Apollo-serverのvalidationRulesオプションを利用し、同時に叩ける Query数を制限 • GraphQL Depth Limitを導入し、深さを制限ならばクエリの数と深さを制限すればいいじゃない

Slide 18

Slide 18 text

Dos攻撃対策 03. PICKで行っている対策同時に叩けるクエリ数を制限 graphql-jsパッケージに含まれる validationContextクラスを使用。（Queryがパースされた ASTが入っている）

Slide 19

Slide 19 text

Dos攻撃対策 03. PICKで行っている対策深さを制限 GraphQL Depth Limitを導入

Slide 20

Slide 20 text

04. まとめ

Slide 21

Slide 21 text

まとめ 04. まとめ • GraphQLはフィールドを縦横無尽に取得できて超便利 • 型がグラフでつながり合った世界にアクセスする仕組みだから • その利便性ゆえに起こる問題 • どこからでも引っ張ってこれることによる、意図しないフィールド露出 • あえて有向グラフにする • resolver関数だけでなくフィールドにも認可を機能をつける • 複雑なクエリや深いクエリを呼ばれることによる DoS攻撃リスク • 同時に叩ける Query数を制限する • 深さを制限するこの2つはかなり手軽に導入できるのでおすすめ

Slide 22

Slide 22 text

今後の課題 04. まとめ • クエリの複雑度分析を取り入れていきたい • IntrospectionやAlias等をOFFにすることの検討 • CQRSとか考慮したい