Skip to content

Commit

Permalink
docs: typos and minor clarifications to oauth2 http filter (envoyprox…
Browse files Browse the repository at this point in the history
…y#35581)


Signed-off-by: Dean Liu <dliu@lyft.com>
  • Loading branch information
skiptomyliu authored Aug 3, 2024
1 parent 6c645a1 commit b5bbfba
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion api/envoy/extensions/filters/http/oauth2/v3/oauth.proto
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ message OAuth2Config {
//
// If this value is not set, it will default to ``604800s``. In this case, the cookie with the refresh token will be expired
// in a week.
// This setting is only considered if ``use_refresh_token`` is set to true, otherwise the authorization server expiration or ``defaul_expires_in`` is used.
// This setting is only considered if ``use_refresh_token`` is set to true, otherwise the authorization server expiration or ``default_expires_in`` is used.
google.protobuf.Duration default_refresh_token_expires_in = 15;

// If set to true, Envoy will not set a cookie for ID Token even if one is received from the Identity Provider. This may be useful in cases where the ID
Expand Down
6 changes: 3 additions & 3 deletions docs/root/configuration/http/http_filters/oauth2_filter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ with the same value.
The OAuth filter encodes URLs in query parameters using the
`URL encoding algorithm. <https://www.w3.org/TR/html5/forms.html#application/x-www-form-urlencoded-encoding-algorithm>`_

When receiving request redirected from the authorization service the Oauth filer decodes URLs from query parameters.
When receiving request redirected from the authorization service the Oauth filter decodes URLs from query parameters.
However the encoded character sequences that represent ASCII control characters or extended ASCII codepoints are not
decoded. The characters without defined meaning in URL according to `RFC 3986 <https://datatracker.ietf.org/doc/html/rfc3986>`_
are also left undecoded. Specifically the following characters are left in the encoded form:
Expand Down Expand Up @@ -252,8 +252,8 @@ during those requests by enabling the :ref:`use_refresh_token <envoy_v3_api_fiel
This behavior can be useful for AJAX requests which cannot handle redirects correctly.

:ref:`use_refresh_token <envoy_v3_api_field_extensions.filters.http.oauth2.v3.OAuth2Config.use_refresh_token>` provides
possibility to update access token by using a refresh token. By default after expiration the user is always redirected to the authorization endpoint to log in again.
By enabling this flag a new access token is obtained using by a refresh token without redirecting the user to log in again. This requires the refresh token to be provided by authorization_endpoint when the user logs in.
the possibility to update access token by using a refresh token. By default after expiration the user is always redirected to the authorization endpoint to log in again.
By enabling this flag a new access token is obtained using the refresh token without redirecting the user to log in again. This requires the refresh token to be provided by the authorization_endpoint when the user logs in.
If the attempt to get an access token by using a refresh token fails then the user is redirected to the authorization endpoint as usual.

Generally, allowlisting is inadvisable from a security standpoint.
Expand Down

0 comments on commit b5bbfba

Please sign in to comment.