snapshot of https://github.com/ory/keto.git (master, 2026-09-16; blobs > 131072B omitted)
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
Some checks failed
CI / Run lints and checks (push) Failing after 47s
CI / Run tests (push) Failing after 1s
CI / Run race tests (push) Failing after 5s
CI / Build CLI docs (push) Has been skipped
CI / Run buf actions (push) Failing after 5s
CodeQL / Analyze (go) (push) Failing after 3s
CodeQL / Analyze (javascript) (push) Failing after 2s
Docker Image Scanners / scanners (push) Failing after 3s
Format / format (push) Failing after 3s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Draft newsletter (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
This commit is contained in:
75
internal/x/validate/validate.go
Normal file
75
internal/x/validate/validate.go
Normal file
@@ -0,0 +1,75 @@
|
||||
// Copyright © 2023 Ory Corp
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package validate
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"io"
|
||||
"net/http"
|
||||
"strings"
|
||||
|
||||
"github.com/ory/herodot"
|
||||
)
|
||||
|
||||
type Validator func(r *http.Request) (ok bool, reason string)
|
||||
|
||||
// All runs all validators and returns an error if any of them fail. It returns
|
||||
// a ErrBadRequest with all failed validation messages.
|
||||
func All(r *http.Request, validator ...Validator) error {
|
||||
var reasons []string
|
||||
for _, v := range validator {
|
||||
if ok, msg := v(r); !ok {
|
||||
reasons = append(reasons, msg)
|
||||
}
|
||||
}
|
||||
if len(reasons) > 0 {
|
||||
return herodot.ErrBadRequest().WithReason(strings.Join(reasons, "; "))
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// NoExtraQueryParams returns a validator that checks if the request has any
|
||||
// query parameters that are not in the except list.
|
||||
func NoExtraQueryParams(except ...string) Validator {
|
||||
return func(req *http.Request) (ok bool, reason string) {
|
||||
allowed := make(map[string]struct{}, len(except))
|
||||
for _, e := range except {
|
||||
allowed[e] = struct{}{}
|
||||
}
|
||||
for key := range req.URL.Query() {
|
||||
if _, found := allowed[key]; !found {
|
||||
return false, fmt.Sprintf("query parameter key %q unknown", key)
|
||||
}
|
||||
}
|
||||
return true, ""
|
||||
}
|
||||
}
|
||||
|
||||
// QueryParamsContainsOneOf returns a validator that checks if the request has
|
||||
// at least one of the specified query parameters.
|
||||
func QueryParamsContainsOneOf(keys ...string) Validator {
|
||||
return func(req *http.Request) (ok bool, reason string) {
|
||||
oneOfKeys := make(map[string]struct{}, len(keys))
|
||||
for _, k := range keys {
|
||||
oneOfKeys[k] = struct{}{}
|
||||
}
|
||||
for key := range req.URL.Query() {
|
||||
if _, found := oneOfKeys[key]; found {
|
||||
return true, ""
|
||||
}
|
||||
}
|
||||
return false, fmt.Sprintf("query parameters must specify at least one of the following: %s", strings.Join(keys, ", "))
|
||||
}
|
||||
}
|
||||
|
||||
// HasEmptyBody returns a validator that checks if the request body is empty.
|
||||
func HasEmptyBody() Validator {
|
||||
return func(r *http.Request) (ok bool, reason string) {
|
||||
_, err := r.Body.Read([]byte{})
|
||||
if err != io.EOF {
|
||||
return false, "body is not empty"
|
||||
}
|
||||
return true, ""
|
||||
}
|
||||
}
|
||||
116
internal/x/validate/validate_test.go
Normal file
116
internal/x/validate/validate_test.go
Normal file
@@ -0,0 +1,116 @@
|
||||
// Copyright © 2023 Ory Corp
|
||||
// SPDX-License-Identifier: Apache-2.0
|
||||
|
||||
package validate_test
|
||||
|
||||
import (
|
||||
"io"
|
||||
"net/http"
|
||||
"net/url"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
||||
"github.com/ory/keto/internal/x/validate"
|
||||
)
|
||||
|
||||
func toURL(t *testing.T, s string) *url.URL {
|
||||
u, err := url.Parse(s)
|
||||
require.NoError(t, err)
|
||||
return u
|
||||
}
|
||||
|
||||
func TestValidateNoExtraParams(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name string
|
||||
req *http.Request
|
||||
assertErr assert.ErrorAssertionFunc
|
||||
}{
|
||||
{
|
||||
name: "empty",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com")},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
{
|
||||
name: "all params",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?foo=1&bar=baz")},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
{
|
||||
name: "extra params",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?foo=1&bar=2&baz=3")},
|
||||
assertErr: assert.Error,
|
||||
},
|
||||
} {
|
||||
t.Run("case="+tt.name, func(t *testing.T) {
|
||||
err := validate.All(tt.req, validate.NoExtraQueryParams("foo", "bar"))
|
||||
tt.assertErr(t, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestQueryParamsContainsOneOf(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name string
|
||||
req *http.Request
|
||||
assertErr assert.ErrorAssertionFunc
|
||||
}{
|
||||
{
|
||||
name: "empty",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com")},
|
||||
assertErr: assert.Error,
|
||||
},
|
||||
{
|
||||
name: "other",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?a=1&b=2&c=3")},
|
||||
assertErr: assert.Error,
|
||||
},
|
||||
{
|
||||
name: "one",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?foo=1")},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
{
|
||||
name: "all params",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?foo=1&bar=baz")},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
{
|
||||
name: "extra params",
|
||||
req: &http.Request{URL: toURL(t, "https://example.com?foo=1&bar=2&baz=3")},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
} {
|
||||
t.Run("case="+tt.name, func(t *testing.T) {
|
||||
err := validate.All(tt.req, validate.QueryParamsContainsOneOf("foo", "bar"))
|
||||
tt.assertErr(t, err)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestValidateHasEmptyBody(t *testing.T) {
|
||||
for _, tt := range []struct {
|
||||
name string
|
||||
req *http.Request
|
||||
assertErr assert.ErrorAssertionFunc
|
||||
}{
|
||||
{
|
||||
name: "empty body",
|
||||
req: &http.Request{Body: io.NopCloser(strings.NewReader(""))},
|
||||
assertErr: assert.NoError,
|
||||
},
|
||||
{
|
||||
name: "non-empty body",
|
||||
req: &http.Request{Body: io.NopCloser(strings.NewReader("content"))},
|
||||
assertErr: assert.Error,
|
||||
},
|
||||
} {
|
||||
t.Run("case="+tt.name, func(t *testing.T) {
|
||||
err := validate.All(tt.req, validate.HasEmptyBody())
|
||||
tt.assertErr(t, err)
|
||||
})
|
||||
}
|
||||
|
||||
}
|
||||
Reference in New Issue
Block a user