envoyproxy/envoy

[OAUTH2] Forward ID Token and Refresh Token

Open

#15,489 opened on Mar 15, 2021

View on GitHub
 (7 comments) (6 reactions) (1 assignee)C++ (5,373 forks)batch import
area/oauthenhancementhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Title: Allow oauth2 forwarding of refresh/id token

Description:

We are trying to use the oauth2 filter to manage an auth2 /oidc flow, but the current implementation can only forward the access token through the filter chain/to downstream and not other tokens potentially returned from the id provider (i.e. refresh token, id token).

I believe this would require an extension of https://github.com/envoyproxy/envoy/blob/23a97fbb237b51f10c19c8c228f74faf7ec65370/source/extensions/filters/http/oauth2/oauth_client.cc#L32

The desired behavior i think would be options of embedding more than just access token in the cookie - perhaps via an additional config to optionally determine which response keys from the /token endpoint should be embedded in the cookie and forwarded using forward_bearer_token: true

Contributor guide

Research direction
Examine the token response structure in oauth client.cc and implement configuration to forward additional tokens (id token, refresh token) via cookies or headers.
Tech stack
cpp
Domain
backendsecurityauthentication
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++GitOAuth2
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30