grpc-ecosystem/grpc-gateway

Document OAuth and JWT examples

Open

#1,313 opened on 2020年5月9日

GitHub で見る
 (5 comments) (5 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
documentationgood first issuehelp wanted

説明

Hi, Is there a good documentation that describes how to add oAuth & Scopes support? I went over the examples (a_bit_of_everything included) but I couldn't figure how its integrated to gRPC and Metadata Hash. Perhaps the Gateway take care of those things and this is why there are no documentation?

Here is what I've found so far:

  • How proto file should be written to support oAuth - ref
  • How to check access token - ref

The question is how I combine the two, if needed at all. Please advise, Thanks!

コントリビューターガイド

技術スタック
gogrpcrest api
領域
documentationapibackendsecurity
Issue 種別
documentation
難度新しい貢献者にとっての実装難度です。1 は非常に小さな変更、5 は専門的な作業です。
3
推定時間経験ある貢献者が調査、実装、テスト、pull request 準備にかけるおおよその時間範囲です。
1-2 days
活動状況Issue が今どれだけ取り組みやすいかを示します。新しい、活発、古い、ブロック中、またはメンテナー入力待ちなどです。
needs maintainer response
明確さ期待される変更、受け入れ条件、次の手順がどれだけ明確かを示します。
clear
前提条件
Go programminggRPC fundamentalsOAuth/JWTprotobuf basics
初心者向け度初回貢献者にどれだけ取り組みやすいかを 1-100 で推定したスコアです。
50
調査方針
Investigate how OAuth and JWT are currently handled in the grpc gateway codebase. The issue references the proto file at examples/internal/proto/examplepb/a bit of everything.proto (line 88) for OAuth scopes, and the grpc go authentication example for checking access tokens. Review existing authentication middleware or interceptors in the gateway. Consider creating a new example or documentation that shows how to combine these two approaches, possibly using the Gateway's metadata hash. Also check if any existing PRs or discussions address this. The goal is to produce clear documentation and example code.