-
Notifications
You must be signed in to change notification settings - Fork 360
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: support session persistence in HTTPRouteRule
Signed-off-by: sanposhiho <44139130+sanposhiho@users.noreply.github.com>
- Loading branch information
1 parent
7b09c21
commit d33c8f3
Showing
8 changed files
with
474 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,140 @@ | ||
| // Copyright Envoy Gateway Authors | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| // The full text of the Apache license is available in the LICENSE file at | ||
| // the root of the repo. | ||
|
|
||
| package translator | ||
|
|
||
| import ( | ||
| "errors" | ||
| "strings" | ||
|
|
||
| routev3 "github.com/envoyproxy/go-control-plane/envoy/config/route/v3" | ||
| hcmv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/filters/network/http_connection_manager/v3" | ||
| cookiev3 "github.com/envoyproxy/go-control-plane/envoy/extensions/http/stateful_session/cookie/v3" | ||
| headerv3 "github.com/envoyproxy/go-control-plane/envoy/extensions/http/stateful_session/header/v3" | ||
| httpv3 "github.com/envoyproxy/go-control-plane/envoy/type/http/v3" | ||
| "google.golang.org/protobuf/proto" | ||
| "google.golang.org/protobuf/types/known/anypb" | ||
| "google.golang.org/protobuf/types/known/durationpb" | ||
|
|
||
| "github.com/envoyproxy/gateway/internal/ir" | ||
| "github.com/envoyproxy/gateway/internal/xds/types" | ||
| ) | ||
|
|
||
| const ( | ||
| sessionPersistenceFilter = "envoy.filters.http.stateful_session" | ||
| ) | ||
|
|
||
| type sessionPersistence struct{} | ||
|
|
||
| func init() { | ||
| registerHTTPFilter(&sessionPersistence{}) | ||
| } | ||
|
|
||
| var _ httpFilter = &sessionPersistence{} | ||
|
|
||
| // patchHCM patches the HttpConnectionManager with the filter. | ||
| // Note: this method may be called multiple times for the same filter, please | ||
| // make sure to avoid duplicate additions of the same filter. | ||
| func (s *sessionPersistence) patchHCM(mgr *hcmv3.HttpConnectionManager, irListener *ir.HTTPListener) error { | ||
| if mgr == nil { | ||
| return errors.New("hcm is nil") | ||
| } | ||
|
|
||
| if irListener == nil { | ||
| return errors.New("ir listener is nil") | ||
| } | ||
|
|
||
| // Return early if filter already exists. | ||
| for _, f := range mgr.HttpFilters { | ||
| if f.Name == sessionPersistenceFilter { | ||
| return nil | ||
| } | ||
| } | ||
|
|
||
| for _, route := range irListener.Routes { | ||
| sp := route.SessionPersistence | ||
| if sp == nil { | ||
| continue | ||
| } | ||
|
|
||
| var cfg proto.Message | ||
| switch { | ||
| case sp.Cookie != nil: | ||
| cfg = &cookiev3.CookieBasedSessionState{ | ||
| Cookie: &httpv3.Cookie{ | ||
| Name: sp.SessionName, | ||
| Path: routePathToCookiePath(route.PathMatch), | ||
| Ttl: durationpb.New(*sp.Cookie.TTL), | ||
| }, | ||
| } | ||
| case sp.Header != nil: | ||
| cfg = &headerv3.HeaderBasedSessionState{ | ||
| Name: sp.SessionName, | ||
| } | ||
| } | ||
|
|
||
| cfgAny, err := anypb.New(cfg) | ||
| if err != nil { | ||
| return err | ||
| } | ||
|
|
||
| mgr.HttpFilters = append(mgr.HttpFilters, &hcmv3.HttpFilter{ | ||
| Name: sessionPersistenceFilter, | ||
| ConfigType: &hcmv3.HttpFilter_TypedConfig{ | ||
| TypedConfig: cfgAny, | ||
| }, | ||
| }) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func routePathToCookiePath(path *ir.StringMatch) string { | ||
| if path == nil { | ||
| return "/" | ||
| } | ||
| switch { | ||
| case path.Exact != nil: | ||
| return *path.Exact | ||
| case path.Prefix != nil: | ||
| return *path.Prefix | ||
| case path.SafeRegex != nil: | ||
| return getLongestNonRegexPrefix(*path.SafeRegex) | ||
| } | ||
|
|
||
| // Shouldn't reach here because the path should be either of the above three kinds. | ||
| return "/" | ||
| } | ||
|
|
||
| // getLongestNonRegexPrefix takes a regex path and returns the longest non-regex prefix. | ||
| // > 3. For an xRoute using a path that is a regex, the Path should be set to the longest non-regex prefix | ||
| // (.e.g. if the path is /p1/p2/*/p3 and the request path was /p1/p2/foo/p3, then the cookie path would be /p1/p2). | ||
| // https://gateway-api.sigs.k8s.io/geps/gep-1619/#path | ||
| func getLongestNonRegexPrefix(path string) string { | ||
| parts := strings.Split(path, "/") | ||
| var longestNonRegexPrefix []string | ||
| for _, part := range parts { | ||
| if part == "*" || strings.Contains(part, "*") { | ||
| break | ||
| } | ||
| longestNonRegexPrefix = append(longestNonRegexPrefix, part) | ||
| } | ||
|
|
||
| return strings.Join(longestNonRegexPrefix, "/") | ||
| } | ||
|
|
||
| // patchRoute patches the provide Route with a filter's Route level configuration. | ||
| func (s *sessionPersistence) patchRoute(route *routev3.Route, irRoute *ir.HTTPRoute) error { | ||
| return nil | ||
| } | ||
|
|
||
| // patchResources adds all the other needed resources referenced by this | ||
| // filter to the resource version table. | ||
| // for example: | ||
| // - a jwt filter needs to add the cluster for the jwks. | ||
| // - an oidc filter needs to add the cluster for token endpoint and the secret | ||
| // for the oauth2 client secret and the hmac secret. | ||
| func (s *sessionPersistence) patchResources(tCtx *types.ResourceVersionTable, routes []*ir.HTTPRoute) error { | ||
| return nil | ||
| } |
Oops, something went wrong.