Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

implement TX v4 experimental #1201

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

implement TX v4 experimental #1201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b1a31a5
implement TX v4 experimental
jptosso Nov 6, 2024
e0b667c
add context support
jptosso Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions experimental/transaction.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
// Copyright 2024 Juan Pablo Tosso and the OWASP Coraza contributors
// SPDX-License-Identifier: Apache-2.0

package experimental

import (
"context"

"github.com/corazawaf/coraza/v3/types"
)

type Transaction interface {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO this interface is meaningless, if someone wants to access this fields they can create their own convenience interface.

Copy link
Member Author

@jptosso jptosso Nov 13, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

package test

import (
	"context"
	"testing"

	"github.com/corazawaf/coraza/v3"
	"github.com/corazawaf/coraza/v3/types"
)

type transaction interface {
	types.Transaction
	Context() context.Context
}

func TestCoraza(t *testing.T) {
	waf, _ := coraza.NewWAF(coraza.NewWAFConfig())
	tx, ok := waf.NewTransaction().(transaction)
	if !ok {
		t.Errorf("cannot access Token")
	}
	tx.Context().Value("key")
}

It is not possible to access internal fields using this hack

Context IS required to control timeout for certain actions, among others

types.Transaction
// UnixTimestamp returns the Unix timestamp of the transaction
UnixTimestamp() int64
// Context returns the context of the transaction
Context() context.Context
}
29 changes: 29 additions & 0 deletions experimental/transaction_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
// Copyright 2024 Juan Pablo Tosso and the OWASP Coraza contributors
// SPDX-License-Identifier: Apache-2.0

package experimental_test

import (
"testing"

"github.com/corazawaf/coraza/v3"
"github.com/corazawaf/coraza/v3/experimental"
)

func TestTxTimestamp(t *testing.T) {
waf, err := coraza.NewWAF(coraza.NewWAFConfig())
if err != nil {
panic(err)
}
tx := waf.NewTransaction()
tx2, ok := tx.(experimental.Transaction)
if !ok {
t.Error("Transaction does not implement experimental.Transaction")
}
if tx2.UnixTimestamp() == 0 {
t.Error("Timestamp should not be 0")
}
if tx2.Context() == nil {
t.Error("Context should not be nil")
}
}
8 changes: 8 additions & 0 deletions internal/corazawaf/transaction.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1576,6 +1576,14 @@ func (tx *Transaction) String() string {
return res.String()
}

func (tx *Transaction) UnixTimestamp() int64 {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is controversial and that is why I'd like to use use cases before exposing this. Why not a time.Time? Not saying that is the answer, just saying we need concrete use cases.

return tx.Timestamp
}

func (tx *Transaction) Context() context.Context {
return tx.context
}

// generateRequestBodyError generates all the error variables for the request body parser
func (tx *Transaction) generateRequestBodyError(err error) {
tx.variables.reqbodyError.Set("1")
Expand Down
Loading