grpc-ecosystem/grpc-gateway

Document OAuth and JWT examples

Ouverte

#1 313 ouverte le 9 mai 2020

Voir sur GitHubGuide contributeur
 (5 commentaires) (5 réactions) (0 personne assignée)Go (2 250 forks)batch import
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (16 971 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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!

Guide contributeur

Direction de recherche
Étudiez comment le grpc gateway gère les jetons OAuth et JWT, en particulier en combinaison avec les métadonnées gRPC. Regardez les exemples existants dans le dépôt (par exemple a bit of everything) et l'exemple d'authentification gRPC Go référencé. Déterminez si la passerelle transmet automatiquement les jetons OAuth au backend ou si une configuration explicite est nécessaire. Créez une documentation expliquant les points d'intégration et fournissez un guide étape par étape avec des annotations proto et une validation côté serveur.
Stack technique
go
Domaine
api
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Plutôt claire
Prérequis
gRPCOAuth
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80