c60cc7ca75
Some checks failed
CI / Run tests and lints (push) Failing after 29s
CI / Build CLI docs (push) Has been skipped
CI / Run Playwright end-to-end tests (mysql) (push) Failing after 3s
CI / Run Playwright end-to-end tests (postgres) (push) Failing after 2s
CI / Run Playwright end-to-end tests (sqlite) (push) Failing after 3s
CodeQL / Analyze (go) (push) Failing after 4s
CodeQL / Analyze (javascript) (push) Failing after 3s
Docker Image Scanners / scanners (push) Failing after 4s
Synchronize Issue Labels / Synchronize Issue Labels (push) Has been skipped
CI / Run end-to-end tests (postgres) (push) Failing after 19s
CI / Run end-to-end tests (sqlite) (push) Failing after 2s
CI / Run Playwright end-to-end tests (cockroach) (push) Failing after 2s
CI / Draft newsletter (push) Has been skipped
CI / Generate release (push) Has been skipped
CI / Pending approval Slack notification (push) Has been skipped
CI / Send newsletter (push) Has been skipped
421 lines
15 KiB
Go
421 lines
15 KiB
Go
// Copyright © 2023 Ory Corp
|
|
// SPDX-License-Identifier: Apache-2.0
|
|
|
|
package settings_test
|
|
|
|
import (
|
|
"context"
|
|
"encoding/json"
|
|
"io"
|
|
"net/http"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/gofrs/uuid"
|
|
"github.com/pkg/errors"
|
|
|
|
"github.com/go-faker/faker/v4"
|
|
"github.com/gobuffalo/httptest"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
"github.com/tidwall/gjson"
|
|
|
|
"github.com/ory/herodot"
|
|
"github.com/ory/kratos/driver/config"
|
|
"github.com/ory/kratos/identity"
|
|
"github.com/ory/kratos/pkg"
|
|
"github.com/ory/kratos/pkg/testhelpers"
|
|
"github.com/ory/kratos/schema"
|
|
"github.com/ory/kratos/selfservice/flow"
|
|
"github.com/ory/kratos/selfservice/flow/settings"
|
|
"github.com/ory/kratos/session"
|
|
"github.com/ory/kratos/text"
|
|
"github.com/ory/kratos/ui/node"
|
|
"github.com/ory/kratos/x"
|
|
"github.com/ory/x/assertx"
|
|
"github.com/ory/x/clock"
|
|
"github.com/ory/x/contextx"
|
|
"github.com/ory/x/urlx"
|
|
)
|
|
|
|
func TestHandleError(t *testing.T) {
|
|
ctx := context.Background()
|
|
conf, reg := pkg.NewFastRegistryWithMocks(t)
|
|
testhelpers.SetDefaultIdentitySchema(conf, "file://./stub/identity.schema.json")
|
|
|
|
public, _ := testhelpers.NewKratosServer(t, reg)
|
|
|
|
router := http.NewServeMux()
|
|
ts := httptest.NewServer(router)
|
|
t.Cleanup(ts.Close)
|
|
|
|
_ = testhelpers.NewSettingsUIFlowEchoServer(t, reg)
|
|
_ = testhelpers.NewErrorTestServer(t, reg)
|
|
loginTS := testhelpers.NewLoginUIFlowEchoServer(t, reg)
|
|
|
|
h := reg.SettingsFlowErrorHandler()
|
|
sdk := testhelpers.NewSDKClient(public)
|
|
|
|
var settingsFlow *settings.Flow
|
|
var flowError error
|
|
var flowMethod node.UiNodeGroup
|
|
var id identity.Identity
|
|
require.NoError(t, faker.FakeData(&id))
|
|
id.SchemaID = "default"
|
|
id.State = identity.StateActive
|
|
require.NoError(t, reg.PrivilegedIdentityPool().CreateIdentity(context.Background(), &id))
|
|
|
|
req := httptest.NewRequest("GET", "/sessions/whoami", nil).WithContext(contextx.WithConfigValue(ctx, config.ViperKeySessionLifespan, time.Hour))
|
|
|
|
// This needs an authenticated client in order to call the RouteGetFlow endpoint
|
|
s, err := testhelpers.NewActiveSession(req, reg, &id, time.Now(), identity.CredentialsTypePassword, identity.AuthenticatorAssuranceLevel1)
|
|
require.NoError(t, err)
|
|
c := testhelpers.NewHTTPClientWithSessionToken(ctx, t, reg, s)
|
|
router.HandleFunc("GET /error", func(w http.ResponseWriter, r *http.Request) {
|
|
h.WriteFlowError(ctx, w, r, flowMethod, settingsFlow, &id, s, flowError)
|
|
})
|
|
|
|
router.HandleFunc("GET /fake-redirect", func(w http.ResponseWriter, r *http.Request) {
|
|
_, _, err := reg.LoginHandler().NewLoginFlow(w, r, flow.TypeBrowser)
|
|
require.NoError(t, err)
|
|
})
|
|
|
|
reset := func() {
|
|
settingsFlow = nil
|
|
flowError = nil
|
|
flowMethod = node.DefaultGroup
|
|
}
|
|
|
|
newFlow := func(t *testing.T, ttl time.Duration, ft flow.Type) *settings.Flow {
|
|
req := &http.Request{URL: urlx.ParseOrPanic("/")}
|
|
f, err := settings.NewFlow(reg, req, &id, ft)
|
|
require.NoError(t, err)
|
|
|
|
for _, s := range reg.SettingsStrategies(context.Background()) {
|
|
require.NoError(t, s.PopulateSettingsMethod(ctx, req, &id, f))
|
|
}
|
|
|
|
require.NoError(t, reg.SettingsFlowPersister().CreateSettingsFlow(context.Background(), f))
|
|
return f
|
|
}
|
|
|
|
expectErrorUI := func(t *testing.T) (map[string]interface{}, *http.Response) {
|
|
res, err := ts.Client().Get(ts.URL + "/error")
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowErrorURL(ctx).String()+"?id=")
|
|
|
|
sse, _, err := sdk.FrontendAPI.GetFlowError(context.Background()).
|
|
Id(res.Request.URL.Query().Get("id")).Execute()
|
|
require.NoError(t, err)
|
|
|
|
return sse.Error, nil
|
|
}
|
|
|
|
expiredAnHourAgo := time.Now().Add(-time.Hour)
|
|
|
|
t.Run("case=error with nil flow defaults to error ui redirect", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
flowError = herodot.ErrInternalServerError().WithReason("system error")
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
sse, _ := expectErrorUI(t)
|
|
assertx.EqualAsJSON(t, flowError, sse)
|
|
})
|
|
|
|
t.Run("case=error with nil flow detects application/json", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
flowError = herodot.ErrInternalServerError().WithReason("system error")
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
assert.Contains(t, res.Header.Get("Content-Type"), "application/json")
|
|
assert.NotContains(t, res.Request.URL.String(), conf.SelfServiceFlowErrorURL(ctx).String()+"?id=")
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assert.Contains(t, string(body), "system error")
|
|
})
|
|
|
|
for _, tc := range []struct {
|
|
n string
|
|
t flow.Type
|
|
}{
|
|
{"api", flow.TypeAPI},
|
|
{"spa", flow.TypeBrowser},
|
|
} {
|
|
t.Run("flow="+tc.n, func(t *testing.T) {
|
|
t.Run("case=expired error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, tc.t)
|
|
flowError = flow.NewFlowExpiredError(clock.New(), expiredAnHourAgo)
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := c.Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Contains(t, res.Request.URL.String(), ts.URL+"/error")
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
require.Equal(t, http.StatusGone, res.StatusCode, "%+v\n\t%s", res.Request, body)
|
|
|
|
assert.NotEqual(t, "00000000-0000-0000-0000-000000000000", gjson.GetBytes(body, "use_flow_id").String())
|
|
// "since" and "error.reason" both derive from time.Since(at), recomputed when the expected error is
|
|
// built here — after the response was generated. Across a rounding boundary the two timings disagree,
|
|
// so exclude both from the exact comparison and verify the reason template separately.
|
|
assertx.EqualAsJSONExcept(t, flow.NewFlowExpiredError(clock.New(), expiredAnHourAgo), json.RawMessage(body), []string{"since", "error.reason", "redirect_browser_to", "use_flow_id"})
|
|
assert.Regexp(t, `^The self-service flow expired \d+\.\d{2} minutes ago, initialize a new one\.$`, gjson.GetBytes(body, "error.reason").String())
|
|
})
|
|
|
|
t.Run("case=validation error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, tc.t)
|
|
flowError = schema.NewInvalidCredentialsError()
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Equal(t, http.StatusBadRequest, res.StatusCode)
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, int(text.ErrorValidationInvalidCredentials), int(gjson.GetBytes(body, "ui.messages.0.id").Int()), "%s", body)
|
|
assert.Equal(t, settingsFlow.ID.String(), gjson.GetBytes(body, "id").String())
|
|
})
|
|
|
|
t.Run("case=return to UI error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = flow.ErrStrategyAsksToReturnToUI
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Equal(t, http.StatusOK, res.StatusCode)
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, settingsFlow.ID.String(), gjson.GetBytes(body, "id").String())
|
|
})
|
|
|
|
t.Run("case=no active session", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = errors.WithStack(session.NewErrNoActiveSessionFound())
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Equal(t, http.StatusUnauthorized, res.StatusCode)
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assert.Equal(t, session.NewErrNoActiveSessionFound().Reason(), gjson.GetBytes(body, "error.reason").String(), "%s", body)
|
|
})
|
|
|
|
t.Run("case=aal too low", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = errors.WithStack(session.NewErrAALNotSatisfied("a"))
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Equal(t, http.StatusForbidden, res.StatusCode)
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assertx.EqualAsJSON(t, session.NewErrAALNotSatisfied("a"), json.RawMessage(body))
|
|
})
|
|
|
|
t.Run("case=generic error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, tc.t)
|
|
flowError = herodot.ErrInternalServerError().WithReason("system error")
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Do(testhelpers.NewHTTPGetJSONRequest(t, ts.URL+"/error"))
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Equal(t, http.StatusInternalServerError, res.StatusCode)
|
|
|
|
body, err := io.ReadAll(res.Body)
|
|
require.NoError(t, err)
|
|
assert.JSONEq(t, x.MustEncodeJSON(t, flowError), gjson.GetBytes(body, "error").Raw)
|
|
})
|
|
})
|
|
}
|
|
|
|
t.Run("flow=browser", func(t *testing.T) {
|
|
expectSettingsUI := func(t *testing.T) (*settings.Flow, *http.Response) {
|
|
res, err := ts.Client().Get(ts.URL + "/error")
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowSettingsUI(ctx).String()+"?flow=")
|
|
|
|
sf, err := reg.SettingsFlowPersister().GetSettingsFlow(context.Background(), uuid.FromStringOrNil(res.Request.URL.Query().Get("flow")))
|
|
require.NoError(t, err)
|
|
return sf, res
|
|
}
|
|
|
|
t.Run("case=expired error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = &settings.Flow{Type: flow.TypeBrowser}
|
|
flowError = flow.NewFlowExpiredError(clock.New(), expiredAnHourAgo)
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
lf, _ := expectSettingsUI(t)
|
|
require.Len(t, lf.UI.Messages, 1)
|
|
assert.Equal(t, int(text.ErrorValidationSettingsFlowExpired), int(lf.UI.Messages[0].ID))
|
|
})
|
|
|
|
t.Run("case=return to ui error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = flow.ErrStrategyAsksToReturnToUI
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
lf, _ := expectSettingsUI(t)
|
|
assert.EqualValues(t, settingsFlow.ID, lf.ID)
|
|
})
|
|
|
|
t.Run("case=no active session error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = errors.WithStack(session.NewErrNoActiveSessionFound())
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Get(ts.URL + "/error")
|
|
require.NoError(t, err)
|
|
require.NoError(t, res.Body.Close())
|
|
assert.Contains(t, res.Request.URL.String(), loginTS.URL)
|
|
|
|
lf, err := reg.LoginFlowPersister().GetLoginFlow(context.Background(), uuid.FromStringOrNil(res.Request.URL.Query().Get("flow")))
|
|
require.NoError(t, err)
|
|
assert.Equal(t, identity.AuthenticatorAssuranceLevel1, lf.RequestedAAL)
|
|
})
|
|
|
|
t.Run("case=aal too low", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
settingsFlow.IdentityID = id.ID
|
|
flowError = errors.WithStack(session.NewErrAALNotSatisfied(conf.SelfServiceFlowLoginUI(ctx).String()))
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
client := &http.Client{}
|
|
*client = *ts.Client()
|
|
|
|
// disable redirects
|
|
client.CheckRedirect = func(req *http.Request, via []*http.Request) error {
|
|
return http.ErrUseLastResponse
|
|
}
|
|
|
|
res, err := client.Get(ts.URL + "/error")
|
|
require.NoError(t, err)
|
|
|
|
loc, err := res.Location()
|
|
require.NoError(t, err)
|
|
|
|
// we should end up at the login URL since the NewALLNotSatisfied takes in a redirect to URL.
|
|
assert.Contains(t, loc.String(), loginTS.URL)
|
|
|
|
// test the JSON resoponse as well
|
|
request, err := http.NewRequest("GET", ts.URL+"/error", nil)
|
|
require.NoError(t, err)
|
|
|
|
request.Header.Add("Accept", "application/json")
|
|
|
|
res, err = client.Do(request)
|
|
require.NoError(t, err)
|
|
|
|
// the body should contain the reason for the error
|
|
body := x.MustReadAll(res.Body)
|
|
require.NoError(t, res.Body.Close())
|
|
|
|
require.NotEmpty(t, gjson.GetBytes(body, "error.reason").String(), "%s", body)
|
|
// We end up at the error endpoint with an aal2 error message because ts.client has no session.
|
|
assert.Equal(t, session.NewErrAALNotSatisfied("").Reason(), gjson.GetBytes(body, "error.reason").String(), "%s", body)
|
|
})
|
|
|
|
t.Run("case=session old error", func(t *testing.T) {
|
|
conf.MustSet(ctx, config.ViperKeyURLsAllowedReturnToDomains, []string{urlx.AppendPaths(conf.SelfPublicURL(ctx), "/error").String()})
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = &settings.Flow{Type: flow.TypeBrowser}
|
|
flowError = settings.NewFlowNeedsReAuth()
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
res, err := ts.Client().Get(ts.URL + "/error")
|
|
require.NoError(t, err)
|
|
defer func() { _ = res.Body.Close() }()
|
|
require.Contains(t, res.Request.URL.String(), conf.GetProvider(ctx).String(config.ViperKeySelfServiceLoginUI))
|
|
})
|
|
|
|
t.Run("case=validation error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
flowError = schema.NewInvalidCredentialsError()
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
lf, _ := expectSettingsUI(t)
|
|
require.NotEmpty(t, lf.UI, x.MustEncodeJSON(t, lf))
|
|
require.Len(t, lf.UI.Messages, 1, x.MustEncodeJSON(t, lf))
|
|
assert.Equal(t, int(text.ErrorValidationInvalidCredentials), int(lf.UI.Messages[0].ID), x.MustEncodeJSON(t, lf))
|
|
})
|
|
|
|
t.Run("case=inaccessible public URL", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
// Since WriteFlowError is invoked directly by the /error handler above,
|
|
// manipulate the schema's URL directly to a bad URL.
|
|
id.SchemaURL = "http://some.random.url"
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
flowError = schema.NewInvalidCredentialsError()
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
lf, _ := expectSettingsUI(t)
|
|
require.NotEmpty(t, lf.UI, x.MustEncodeJSON(t, lf))
|
|
require.Len(t, lf.UI.Messages, 1, x.MustEncodeJSON(t, lf))
|
|
assert.Equal(t, int(text.ErrorValidationInvalidCredentials), int(lf.UI.Messages[0].ID), x.MustEncodeJSON(t, lf))
|
|
})
|
|
|
|
t.Run("case=generic error", func(t *testing.T) {
|
|
t.Cleanup(reset)
|
|
|
|
settingsFlow = newFlow(t, time.Minute, flow.TypeBrowser)
|
|
flowError = herodot.ErrInternalServerError().WithReason("system error")
|
|
flowMethod = settings.StrategyProfile
|
|
|
|
sse, _ := expectErrorUI(t)
|
|
assertx.EqualAsJSON(t, flowError, sse)
|
|
})
|
|
})
|
|
}
|