Compare commits

...

4 Commits

Author SHA1 Message Date
wpetit a686c52aed Merge pull request 'fix(rewriter): prevent mixing of cached rule engines (#44)' (#45) from issue-44 into develop
Cadoles/bouncer/pipeline/head This commit looks good Details
Reviewed-on: #45
2024-10-21 14:07:51 +02:00
wpetit c0470ca623 feat: better display of large error messsages
Cadoles/bouncer/pipeline/head Build queued... Details
Cadoles/bouncer/pipeline/pr-develop Build queued... Details
2024-10-21 13:49:32 +02:00
wpetit c611705d45 fix(rewriter): prevent mixing of cached rule engines (#44) 2024-10-21 13:48:59 +02:00
wpetit 16fa751dc7 doc: fix rewriter rule method name 2024-10-21 13:48:07 +02:00
8 changed files with 80 additions and 31 deletions

View File

@ -60,7 +60,7 @@ Retourne `nil` si le cookie n'existe pas.
} }
``` ```
##### `set_cookie(ctx, cookie Cookie)` ##### `add_cookie(ctx, cookie Cookie)`
Définit un cookie sur la requête/réponse (en fonction du contexte d'utilisation). Définit un cookie sur la requête/réponse (en fonction du contexte d'utilisation).
Voir la méthode `get_cookie()` pour voir les attributs potentiels. Voir la méthode `get_cookie()` pour voir les attributs potentiels.

View File

@ -10,6 +10,9 @@ import (
"forge.cadoles.com/Cadoles/go-proxy" "forge.cadoles.com/Cadoles/go-proxy"
"forge.cadoles.com/Cadoles/go-proxy/wildcard" "forge.cadoles.com/Cadoles/go-proxy/wildcard"
"forge.cadoles.com/cadoles/bouncer/internal/proxy/director" "forge.cadoles.com/cadoles/bouncer/internal/proxy/director"
"forge.cadoles.com/cadoles/bouncer/internal/proxy/director/layer/util"
"forge.cadoles.com/cadoles/bouncer/internal/rule"
ruleHTTP "forge.cadoles.com/cadoles/bouncer/internal/rule/http"
"forge.cadoles.com/cadoles/bouncer/internal/store" "forge.cadoles.com/cadoles/bouncer/internal/store"
"github.com/Masterminds/sprig/v3" "github.com/Masterminds/sprig/v3"
"github.com/pkg/errors" "github.com/pkg/errors"
@ -21,6 +24,8 @@ type Layer struct {
auth Authenticator auth Authenticator
debug bool debug bool
ruleEngineCache *util.RuleEngineCache[*Vars, *LayerOptions]
templateDir string templateDir string
} }
@ -74,7 +79,7 @@ func (l *Layer) Middleware(layer *store.Layer) proxy.Middleware {
return return
} }
if err := l.applyRules(ctx, r, options, user); err != nil { if err := l.applyRules(ctx, r, layer, options, user); err != nil {
if errors.Is(err, ErrForbidden) { if errors.Is(err, ErrForbidden) {
l.renderForbiddenPage(w, r, layer, options, user) l.renderForbiddenPage(w, r, layer, options, user)
return return
@ -189,6 +194,18 @@ func NewLayer(layerType store.LayerType, auth Authenticator, funcs ...OptionFunc
opts := NewOptions(funcs...) opts := NewOptions(funcs...)
return &Layer{ return &Layer{
ruleEngineCache: util.NewInMemoryRuleEngineCache[*Vars, *LayerOptions](func(options *LayerOptions) (*rule.Engine[*Vars], error) {
engine, err := rule.NewEngine[*Vars](
rule.WithRules(options.Rules...),
rule.WithExpr(getAuthnAPI()...),
ruleHTTP.WithRequestFuncs(),
)
if err != nil {
return nil, errors.WithStack(err)
}
return engine, nil
}),
layerType: layerType, layerType: layerType,
auth: auth, auth: auth,
templateDir: opts.TemplateDir, templateDir: opts.TemplateDir,

View File

@ -28,12 +28,13 @@ func DefaultLayerOptions() LayerOptions {
return LayerOptions{ return LayerOptions{
MatchURLs: []string{"*"}, MatchURLs: []string{"*"},
Rules: []string{ Rules: []string{
"del_headers('Remote-*')", "del_headers(ctx, 'Remote-*')",
"set_header('Remote-User', user.subject)", "set_header(ctx,'Remote-User', vars.user.subject)",
`map( `map(
toPairs(user.attrs), { toPairs(vars.user.attrs), {
let name = replace(lower(string(get(#, 0))), '_', '-'); let name = replace(lower(string(get(#, 0))), '_', '-');
set_header( set_header(
ctx,
'Remote-User-Attr-' + name, 'Remote-User-Attr-' + name,
get(#, 1) get(#, 1)
) )

View File

@ -4,8 +4,8 @@ import (
"context" "context"
"net/http" "net/http"
"forge.cadoles.com/cadoles/bouncer/internal/rule"
ruleHTTP "forge.cadoles.com/cadoles/bouncer/internal/rule/http" ruleHTTP "forge.cadoles.com/cadoles/bouncer/internal/rule/http"
"forge.cadoles.com/cadoles/bouncer/internal/store"
"github.com/expr-lang/expr" "github.com/expr-lang/expr"
"github.com/pkg/errors" "github.com/pkg/errors"
) )
@ -14,17 +14,11 @@ type Vars struct {
User *User `expr:"user"` User *User `expr:"user"`
} }
func (l *Layer) applyRules(ctx context.Context, r *http.Request, options *LayerOptions, user *User) error { func (l *Layer) applyRules(ctx context.Context, r *http.Request, layer *store.Layer, options *LayerOptions, user *User) error {
rules := options.Rules key := string(layer.Proxy) + "-" + string(layer.Name)
if len(rules) == 0 { revisionedEngine := l.ruleEngineCache.Get(key)
return nil
}
engine, err := rule.NewEngine[*Vars]( engine, err := revisionedEngine.Get(ctx, layer.Revision, options)
rule.WithRules(options.Rules...),
rule.WithExpr(getAuthnAPI()...),
ruleHTTP.WithRequestFuncs(),
)
if err != nil { if err != nil {
return errors.WithStack(err) return errors.WithStack(err)
} }

View File

@ -16,8 +16,8 @@ import (
const LayerType store.LayerType = "rewriter" const LayerType store.LayerType = "rewriter"
type Layer struct { type Layer struct {
requestRuleEngine *util.RevisionedRuleEngine[*RequestVars, *LayerOptions] requestRuleEngineCache *util.RuleEngineCache[*RequestVars, *LayerOptions]
responseRuleEngine *util.RevisionedRuleEngine[*ResponseVars, *LayerOptions] responseRuleEngineCache *util.RuleEngineCache[*ResponseVars, *LayerOptions]
} }
func (l *Layer) LayerType() store.LayerType { func (l *Layer) LayerType() store.LayerType {
@ -42,7 +42,7 @@ func (l *Layer) Middleware(layer *store.Layer) proxy.Middleware {
return return
} }
if err := l.applyRequestRules(ctx, r, layer.Revision, options); err != nil { if err := l.applyRequestRules(ctx, r, layer, options); err != nil {
var redirect *errRedirect var redirect *errRedirect
if errors.As(err, &redirect) { if errors.As(err, &redirect) {
http.Redirect(w, r, redirect.URL(), redirect.StatusCode()) http.Redirect(w, r, redirect.URL(), redirect.StatusCode())
@ -76,7 +76,7 @@ func (l *Layer) ResponseTransformer(layer *store.Layer) proxy.ResponseTransforme
ctx := r.Request.Context() ctx := r.Request.Context()
if err := l.applyResponseRules(ctx, r, layer.Revision, options); err != nil { if err := l.applyResponseRules(ctx, r, layer, options); err != nil {
return errors.WithStack(err) return errors.WithStack(err)
} }
@ -86,7 +86,7 @@ func (l *Layer) ResponseTransformer(layer *store.Layer) proxy.ResponseTransforme
func New(funcs ...OptionFunc) *Layer { func New(funcs ...OptionFunc) *Layer {
return &Layer{ return &Layer{
requestRuleEngine: util.NewRevisionedRuleEngine(func(options *LayerOptions) (*rule.Engine[*RequestVars], error) { requestRuleEngineCache: util.NewInMemoryRuleEngineCache(func(options *LayerOptions) (*rule.Engine[*RequestVars], error) {
engine, err := rule.NewEngine[*RequestVars]( engine, err := rule.NewEngine[*RequestVars](
rule.WithRules(options.Rules.Request...), rule.WithRules(options.Rules.Request...),
ruleHTTP.WithRequestFuncs(), ruleHTTP.WithRequestFuncs(),
@ -98,7 +98,7 @@ func New(funcs ...OptionFunc) *Layer {
return engine, nil return engine, nil
}), }),
responseRuleEngine: util.NewRevisionedRuleEngine(func(options *LayerOptions) (*rule.Engine[*ResponseVars], error) { responseRuleEngineCache: util.NewInMemoryRuleEngineCache(func(options *LayerOptions) (*rule.Engine[*ResponseVars], error) {
engine, err := rule.NewEngine[*ResponseVars]( engine, err := rule.NewEngine[*ResponseVars](
rule.WithRules(options.Rules.Response...), rule.WithRules(options.Rules.Response...),
ruleHTTP.WithResponseFuncs(), ruleHTTP.WithResponseFuncs(),

View File

@ -8,6 +8,7 @@ import (
"forge.cadoles.com/cadoles/bouncer/internal/proxy/director" "forge.cadoles.com/cadoles/bouncer/internal/proxy/director"
"forge.cadoles.com/cadoles/bouncer/internal/rule" "forge.cadoles.com/cadoles/bouncer/internal/rule"
ruleHTTP "forge.cadoles.com/cadoles/bouncer/internal/rule/http" ruleHTTP "forge.cadoles.com/cadoles/bouncer/internal/rule/http"
"forge.cadoles.com/cadoles/bouncer/internal/store"
"github.com/pkg/errors" "github.com/pkg/errors"
) )
@ -87,13 +88,13 @@ func fromRequest(r *http.Request) RequestVar {
} }
} }
func (l *Layer) applyRequestRules(ctx context.Context, r *http.Request, layerRevision int, options *LayerOptions) error { func (l *Layer) applyRequestRules(ctx context.Context, r *http.Request, layer *store.Layer, options *LayerOptions) error {
rules := options.Rules.Request rules := options.Rules.Request
if len(rules) == 0 { if len(rules) == 0 {
return nil return nil
} }
engine, err := l.getRequestRuleEngine(ctx, layerRevision, options) engine, err := l.getRequestRuleEngine(ctx, layer, options)
if err != nil { if err != nil {
return errors.WithStack(err) return errors.WithStack(err)
} }
@ -117,8 +118,11 @@ func (l *Layer) applyRequestRules(ctx context.Context, r *http.Request, layerRev
return nil return nil
} }
func (l *Layer) getRequestRuleEngine(ctx context.Context, layerRevision int, options *LayerOptions) (*rule.Engine[*RequestVars], error) { func (l *Layer) getRequestRuleEngine(ctx context.Context, layer *store.Layer, options *LayerOptions) (*rule.Engine[*RequestVars], error) {
engine, err := l.requestRuleEngine.Get(ctx, layerRevision, options) key := string(layer.Proxy) + "-" + string(layer.Name)
revisionedEngine := l.requestRuleEngineCache.Get(key)
engine, err := revisionedEngine.Get(ctx, layer.Revision, options)
if err != nil { if err != nil {
return nil, errors.WithStack(err) return nil, errors.WithStack(err)
} }
@ -145,13 +149,13 @@ type ResponseVar struct {
Trailer map[string][]string `expr:"trailer"` Trailer map[string][]string `expr:"trailer"`
} }
func (l *Layer) applyResponseRules(ctx context.Context, r *http.Response, layerRevision int, options *LayerOptions) error { func (l *Layer) applyResponseRules(ctx context.Context, r *http.Response, layer *store.Layer, options *LayerOptions) error {
rules := options.Rules.Response rules := options.Rules.Response
if len(rules) == 0 { if len(rules) == 0 {
return nil return nil
} }
engine, err := l.getResponseRuleEngine(ctx, layerRevision, options) engine, err := l.getResponseRuleEngine(ctx, layer, options)
if err != nil { if err != nil {
return errors.WithStack(err) return errors.WithStack(err)
} }
@ -187,8 +191,11 @@ func (l *Layer) applyResponseRules(ctx context.Context, r *http.Response, layerR
return nil return nil
} }
func (l *Layer) getResponseRuleEngine(ctx context.Context, layerRevision int, options *LayerOptions) (*rule.Engine[*ResponseVars], error) { func (l *Layer) getResponseRuleEngine(ctx context.Context, layer *store.Layer, options *LayerOptions) (*rule.Engine[*ResponseVars], error) {
engine, err := l.responseRuleEngine.Get(ctx, layerRevision, options) key := string(layer.Proxy) + "-" + string(layer.Name)
revisionedEngine := l.responseRuleEngineCache.Get(key)
engine, err := revisionedEngine.Get(ctx, layer.Revision, options)
if err != nil { if err != nil {
return nil, errors.WithStack(err) return nil, errors.WithStack(err)
} }

View File

@ -0,0 +1,28 @@
package util
import (
"forge.cadoles.com/cadoles/bouncer/internal/cache"
"forge.cadoles.com/cadoles/bouncer/internal/cache/memory"
)
type RuleEngineCache[V any, O any] struct {
cache cache.Cache[string, *RevisionedRuleEngine[V, O]]
factory RuleEngineFactoryFunc[V, O]
}
func (c *RuleEngineCache[V, O]) Get(key string) *RevisionedRuleEngine[V, O] {
revisionedRuleEngine, exists := c.cache.Get(key)
if !exists {
revisionedRuleEngine = NewRevisionedRuleEngine(c.factory)
c.cache.Set(key, revisionedRuleEngine)
}
return revisionedRuleEngine
}
func NewInMemoryRuleEngineCache[V any, O any](factory RuleEngineFactoryFunc[V, O]) *RuleEngineCache[V, O] {
return &RuleEngineCache[V, O]{
factory: factory,
cache: memory.NewCache[string, *RevisionedRuleEngine[V, O]](),
}
}

View File

@ -55,6 +55,8 @@
border-radius: 5px; border-radius: 5px;
box-shadow: 2px 2px #cccccc1c; box-shadow: 2px 2px #cccccc1c;
color: #810000 !important; color: #810000 !important;
max-width: 80%;
overflow-x: hidden;
} }
.title { .title {
@ -81,7 +83,7 @@
<div id="card"> <div id="card">
<h2 class="title">Une erreur est survenue !</h2> <h2 class="title">Une erreur est survenue !</h2>
{{ if .Debug }} {{ if .Debug }}
<pre>{{ .Err }}</pre> <pre style="overflow-x: auto">{{ .Err }}</pre>
{{ end }} {{ end }}
{{/* if a public base url is provided, show navigation link */}} {{/* if a public base url is provided, show navigation link */}}
{{ $oidc := ( index .Layer.Options "oidc" ) }} {{ $oidc := ( index .Layer.Options "oidc" ) }}