Files
zitadel/internal/query/target_test.go
T
791d0587aa feat(action v2): add JWT and JWE payload type options (#11196)
# Which Problems Are Solved

The payload in actions V2 is currently sent as JSON to the target
endpoint. It might get exposed to intermediary infrastructure or logging
systems.
For these scenarios there needs to be an application-layer encryption,
where the provider of the endpoint can define an key to be used for the
encryption.

# How the Problems Are Solved

- Added an additional option to the target to specify the payload type:
`JSON` (current and default), `JWT`, `JWE` (api and console)
- added endpoints to upload and manage public keys (to be used for
encryption) for a target
- updated all action v2 executions (interceptors, oidc, saml, ...) to
provide the `GetActiveSigningWebKey` from queries
- implemented jwt and jwe in the exections incl. refactoring of code and
tests
- changes to the authn_keys table:
  - added a `fingerprint` column
  - dropped not null constraint on expiration
- moved the `GetSignerOnce` into its own package to prevent circular
dependencies

# Additional Changes

None

# Additional Context

closes #11061

---------

Co-authored-by: Marco A. <[email protected]>
Co-authored-by: conblem <[email protected]>
Co-authored-by: Silvan <[email protected]>
2025-12-29 13:35:53 +00:00

394 lines
9.7 KiB
Go

package query
import (
"database/sql"
"database/sql/driver"
"errors"
"fmt"
"regexp"
"testing"
"time"
"github.com/zitadel/zitadel/internal/crypto"
"github.com/zitadel/zitadel/internal/domain"
target_domain "github.com/zitadel/zitadel/internal/execution/target"
"github.com/zitadel/zitadel/internal/zerrors"
)
var (
prepareTargetsStmt = `SELECT projections.targets2.id,` +
` projections.targets2.creation_date,` +
` projections.targets2.change_date,` +
` projections.targets2.resource_owner,` +
` projections.targets2.name,` +
` projections.targets2.target_type,` +
` projections.targets2.timeout,` +
` projections.targets2.endpoint,` +
` projections.targets2.interrupt_on_error,` +
` projections.targets2.signing_key,` +
` projections.targets2.payload_type,` +
` COUNT(*) OVER ()` +
` FROM projections.targets2`
prepareTargetsCols = []string{
"id",
"creation_date",
"change_date",
"resource_owner",
"name",
"target_type",
"timeout",
"endpoint",
"interrupt_on_error",
"signing_key",
"payload_type",
"count",
}
prepareTargetStmt = `SELECT projections.targets2.id,` +
` projections.targets2.creation_date,` +
` projections.targets2.change_date,` +
` projections.targets2.resource_owner,` +
` projections.targets2.name,` +
` projections.targets2.target_type,` +
` projections.targets2.timeout,` +
` projections.targets2.endpoint,` +
` projections.targets2.interrupt_on_error,` +
` projections.targets2.signing_key,` +
` projections.targets2.payload_type` +
` FROM projections.targets2`
prepareTargetCols = []string{
"id",
"creation_date",
"change_date",
"resource_owner",
"name",
"target_type",
"timeout",
"endpoint",
"interrupt_on_error",
"signing_key",
"payload_type",
}
)
func Test_TargetPrepares(t *testing.T) {
type want struct {
sqlExpectations sqlExpectation
err checkErr
}
tests := []struct {
name string
prepare interface{}
want want
object interface{}
}{
{
name: "prepareTargetsQuery no result",
prepare: prepareTargetsQuery,
want: want{
sqlExpectations: mockQueries(
regexp.QuoteMeta(prepareTargetsStmt),
nil,
nil,
),
},
object: &Targets{Targets: []*Target{}},
},
{
name: "prepareTargetsQuery one result",
prepare: prepareTargetsQuery,
want: want{
sqlExpectations: mockQueries(
regexp.QuoteMeta(prepareTargetsStmt),
prepareTargetsCols,
[][]driver.Value{
{
"id",
testNow,
testNow,
"ro",
"target-name",
target_domain.TargetTypeWebhook,
1 * time.Second,
"https://example.com",
true,
&crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
target_domain.PayloadTypeJSON,
},
},
),
},
object: &Targets{
SearchResponse: SearchResponse{
Count: 1,
},
Targets: []*Target{
{
ObjectDetails: domain.ObjectDetails{
ID: "id",
EventDate: testNow,
CreationDate: testNow,
ResourceOwner: "ro",
},
Name: "target-name",
TargetType: target_domain.TargetTypeWebhook,
Timeout: 1 * time.Second,
Endpoint: "https://example.com",
InterruptOnError: true,
signingKey: &crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
PayloadType: target_domain.PayloadTypeJSON,
},
},
},
},
{
name: "prepareTargetsQuery multiple result",
prepare: prepareTargetsQuery,
want: want{
sqlExpectations: mockQueries(
regexp.QuoteMeta(prepareTargetsStmt),
prepareTargetsCols,
[][]driver.Value{
{
"id-1",
testNow,
testNow,
"ro",
"target-name1",
target_domain.TargetTypeWebhook,
1 * time.Second,
"https://example.com",
true,
&crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
target_domain.PayloadTypeJSON,
},
{
"id-2",
testNow,
testNow,
"ro",
"target-name2",
target_domain.TargetTypeWebhook,
1 * time.Second,
"https://example.com",
false,
&crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
target_domain.PayloadTypeJWT,
},
{
"id-3",
testNow,
testNow,
"ro",
"target-name3",
target_domain.TargetTypeAsync,
1 * time.Second,
"https://example.com",
false,
&crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
target_domain.PayloadTypeJWE,
},
},
),
},
object: &Targets{
SearchResponse: SearchResponse{
Count: 3,
},
Targets: []*Target{
{
ObjectDetails: domain.ObjectDetails{
ID: "id-1",
EventDate: testNow,
CreationDate: testNow,
ResourceOwner: "ro",
},
Name: "target-name1",
TargetType: target_domain.TargetTypeWebhook,
Timeout: 1 * time.Second,
Endpoint: "https://example.com",
InterruptOnError: true,
signingKey: &crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
PayloadType: target_domain.PayloadTypeJSON,
},
{
ObjectDetails: domain.ObjectDetails{
ID: "id-2",
EventDate: testNow,
CreationDate: testNow,
ResourceOwner: "ro",
},
Name: "target-name2",
TargetType: target_domain.TargetTypeWebhook,
Timeout: 1 * time.Second,
Endpoint: "https://example.com",
InterruptOnError: false,
signingKey: &crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
PayloadType: target_domain.PayloadTypeJWT,
},
{
ObjectDetails: domain.ObjectDetails{
ID: "id-3",
EventDate: testNow,
CreationDate: testNow,
ResourceOwner: "ro",
},
Name: "target-name3",
TargetType: target_domain.TargetTypeAsync,
Timeout: 1 * time.Second,
Endpoint: "https://example.com",
InterruptOnError: false,
signingKey: &crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
PayloadType: target_domain.PayloadTypeJWE,
},
},
},
},
{
name: "prepareTargetsQuery sql err",
prepare: prepareTargetsQuery,
want: want{
sqlExpectations: mockQueryErr(
regexp.QuoteMeta(prepareTargetsStmt),
sql.ErrConnDone,
),
err: func(err error) (error, bool) {
if !errors.Is(err, sql.ErrConnDone) {
return fmt.Errorf("err should be sql.ErrConnDone got: %w", err), false
}
return nil, true
},
},
object: (*Target)(nil),
},
{
name: "prepareTargetQuery no result",
prepare: prepareTargetQuery,
want: want{
sqlExpectations: mockQueriesScanErr(
regexp.QuoteMeta(prepareTargetStmt),
nil,
nil,
),
err: func(err error) (error, bool) {
if !zerrors.IsNotFound(err) {
return fmt.Errorf("err should be zitadel.NotFoundError got: %w", err), false
}
return nil, true
},
},
object: (*Target)(nil),
},
{
name: "prepareTargetQuery found",
prepare: prepareTargetQuery,
want: want{
sqlExpectations: mockQuery(
regexp.QuoteMeta(prepareTargetStmt),
prepareTargetCols,
[]driver.Value{
"id",
testNow,
testNow,
"ro",
"target-name",
target_domain.TargetTypeWebhook,
1 * time.Second,
"https://example.com",
true,
&crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
target_domain.PayloadTypeJSON,
},
),
},
object: &Target{
ObjectDetails: domain.ObjectDetails{
ID: "id",
EventDate: testNow,
CreationDate: testNow,
ResourceOwner: "ro",
},
Name: "target-name",
TargetType: target_domain.TargetTypeWebhook,
Timeout: 1 * time.Second,
Endpoint: "https://example.com",
InterruptOnError: true,
signingKey: &crypto.CryptoValue{
CryptoType: crypto.TypeEncryption,
Algorithm: "alg",
KeyID: "encKey",
Crypted: []byte("crypted"),
},
PayloadType: target_domain.PayloadTypeJSON,
},
},
{
name: "prepareTargetQuery sql err",
prepare: prepareTargetQuery,
want: want{
sqlExpectations: mockQueryErr(
regexp.QuoteMeta(prepareTargetStmt),
sql.ErrConnDone,
),
err: func(err error) (error, bool) {
if !errors.Is(err, sql.ErrConnDone) {
return fmt.Errorf("err should be sql.ErrConnDone got: %w", err), false
}
return nil, true
},
},
object: (*Target)(nil),
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
assertPrepare(t, tt.prepare, tt.object, tt.want.sqlExpectations, tt.want.err)
})
}
}