Files
upstream-ory-kratos/selfservice/strategy/link/strategy_recovery_test.go
upstream-mirror 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
snapshot of https://github.com/ory/kratos.git (master, 2026-09-15; blobs > 131072B omitted)
2026-09-15 21:19:12 +05:00

925 lines
38 KiB
Go

// Copyright © 2023 Ory Corp
// SPDX-License-Identifier: Apache-2.0
package link_test
import (
"encoding/json"
"fmt"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"sync"
"testing"
"time"
"github.com/davecgh/go-spew/spew"
"github.com/gofrs/uuid"
"github.com/pkg/errors"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"github.com/tidwall/gjson"
"github.com/ory/kratos/corpx"
"github.com/ory/kratos/driver"
"github.com/ory/kratos/driver/config"
"github.com/ory/kratos/identity"
"github.com/ory/kratos/pkg"
kratos "github.com/ory/kratos/pkg/httpclient"
"github.com/ory/kratos/pkg/testhelpers"
"github.com/ory/kratos/selfservice/flow"
"github.com/ory/kratos/selfservice/flow/recovery"
"github.com/ory/kratos/selfservice/strategy/link"
"github.com/ory/kratos/session"
"github.com/ory/kratos/text"
"github.com/ory/kratos/ui/node"
"github.com/ory/kratos/x"
"github.com/ory/kratos/x/nosurfx"
"github.com/ory/x/assertx"
"github.com/ory/x/clock"
"github.com/ory/x/contextx"
"github.com/ory/x/ioutilx"
"github.com/ory/x/sqlxx"
"github.com/ory/x/urlx"
)
func init() {
corpx.RegisterFakes()
}
func createIdentityToRecover(t *testing.T, reg *driver.RegistryDefault, email string) *identity.Identity {
id := &identity.Identity{
Credentials: map[identity.CredentialsType]identity.Credentials{
"password": {Type: "password", Identifiers: []string{email}, Config: sqlxx.JSONRawMessage(`{"hashed_password":"foo"}`)},
},
Traits: identity.Traits(fmt.Sprintf(`{"email":"%s"}`, email)),
SchemaID: config.DefaultIdentityTraitsSchemaID,
}
require.NoError(t, reg.IdentityManager().Create(t.Context(), id, identity.ManagerAllowWriteProtectedTraits))
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, email)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
return id
}
func TestAdminStrategy(t *testing.T) {
ctx := t.Context()
conf, reg := pkg.NewFastRegistryWithMocks(t)
initViper(t, conf)
_ = testhelpers.NewRecoveryUIFlowEchoServer(t, reg)
_ = testhelpers.NewSettingsUIFlowEchoServer(t, reg)
_ = testhelpers.NewLoginUIFlowEchoServer(t, reg)
_ = testhelpers.NewErrorTestServer(t, reg)
publicTS, adminTS := testhelpers.NewKratosServer(t, reg)
adminSDK := testhelpers.NewSDKClient(adminTS)
checkLink := func(t *testing.T, l *kratos.RecoveryLinkForIdentity, isBefore time.Time) {
require.Contains(t, l.RecoveryLink, publicTS.URL+recovery.RouteSubmitFlow)
rl := urlx.ParseOrPanic(l.RecoveryLink)
assert.NotEmpty(t, rl.Query().Get("token"))
assert.NotEmpty(t, rl.Query().Get("flow"))
require.True(t, (*l.ExpiresAt).Before(isBefore))
}
t.Run("no panic on empty body #1384", func(t *testing.T) {
s, ps, err := reg.RecoveryStrategies(t.Context()).ActiveStrategies("link")
require.NoError(t, err)
r := &http.Request{URL: new(url.URL)}
f, err := recovery.NewFlow(reg, time.Minute, "", r, s, flow.TypeBrowser)
require.NoError(t, err)
require.IsType(t, &link.Strategy{}, ps)
expectedErr := errors.New("test")
err = ps.(*link.Strategy).HandleRecoveryError(r, f, nil, expectedErr)
require.ErrorIs(t, err, expectedErr)
})
t.Run("description=should not be able to recover an account that does not exist", func(t *testing.T) {
_, _, err := adminSDK.IdentityAPI.CreateRecoveryLinkForIdentity(t.Context()).CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: x.NewUUID().String(),
}).Execute()
require.IsTypef(t, err, new(kratos.GenericOpenAPIError), "%T", err)
assert.EqualError(t, err, "400 Bad Request")
})
t.Run("description=should create a valid recovery link without email", func(t *testing.T) {
id := identity.Identity{Traits: identity.Traits(`{}`)}
require.NoError(t, reg.IdentityManager().Create(t.Context(),
&id, identity.ManagerAllowWriteProtectedTraits))
rl, _, err := adminSDK.IdentityAPI.CreateRecoveryLinkForIdentity(t.Context()).CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
ExpiresIn: new("100ms"),
}).Execute()
require.NoError(t, err)
time.Sleep(time.Millisecond * 100)
checkLink(t, rl, time.Now().Add(conf.SelfServiceFlowRecoveryRequestLifespan(ctx)))
res, err := publicTS.Client().Get(rl.RecoveryLink)
require.NoError(t, err)
require.Equal(t, http.StatusOK, res.StatusCode)
// We end up here because the link is expired.
assert.Contains(t, res.Request.URL.Path, "/recover", rl.RecoveryLink)
})
t.Run("description=should create a valid recovery link and set the expiry time and not be able to recover the account", func(t *testing.T) {
recoveryEmail := "recover.expired@ory.sh"
id := identity.Identity{Traits: identity.Traits(fmt.Sprintf(`{"email":"%s"}`, recoveryEmail))}
require.NoError(t, reg.IdentityManager().Create(t.Context(),
&id, identity.ManagerAllowWriteProtectedTraits))
rl, _, err := adminSDK.IdentityAPI.CreateRecoveryLinkForIdentity(t.Context()).CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
ExpiresIn: new("100ms"),
}).Execute()
require.NoError(t, err)
time.Sleep(time.Millisecond * 100)
checkLink(t, rl, time.Now().Add(conf.SelfServiceFlowRecoveryRequestLifespan(ctx)))
res, err := publicTS.Client().Get(rl.RecoveryLink)
require.NoError(t, err)
require.Equal(t, http.StatusOK, res.StatusCode)
// We end up here because the link is expired.
assert.Contains(t, res.Request.URL.Path, "/recover", rl.RecoveryLink)
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
})
t.Run("description=should create a valid recovery link and set the expiry time as well and recover the account", func(t *testing.T) {
recoveryEmail := "recoverme@ory.sh"
id := identity.Identity{Traits: identity.Traits(fmt.Sprintf(`{"email":"%s"}`, recoveryEmail))}
require.NoError(t, reg.IdentityManager().Create(t.Context(),
&id, identity.ManagerAllowWriteProtectedTraits))
rl, _, err := adminSDK.IdentityAPI.CreateRecoveryLinkForIdentity(t.Context()).CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
}).Execute()
require.NoError(t, err)
checkLink(t, rl, time.Now().Add(conf.SelfServiceFlowRecoveryRequestLifespan(ctx)+time.Second))
res, err := publicTS.Client().Get(rl.RecoveryLink)
require.NoError(t, err)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowSettingsUI(ctx).String())
assert.Equal(t, http.StatusOK, res.StatusCode)
testhelpers.LogJSON(t, rl)
f, err := reg.SettingsFlowPersister().GetSettingsFlow(t.Context(), uuid.FromStringOrNil(res.Request.URL.Query().Get("flow")))
require.NoError(t, err, "%s", res.Request.URL.String())
require.Len(t, f.UI.Messages, 1)
assert.Equal(t, "You successfully recovered your account. Please change your password or set up an alternative login method (e.g. social sign in) within the next 60.00 minutes.", f.UI.Messages[0].Text)
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
})
t.Run("case=should not be able to use code from different flow", func(t *testing.T) {
email := strings.ToLower(testhelpers.RandomEmail())
id := createIdentityToRecover(t, reg, email)
rl1, _, err := adminSDK.IdentityAPI.
CreateRecoveryLinkForIdentity(t.Context()).
CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
}).
Execute()
require.NoError(t, err)
checkLink(t, rl1, time.Now().Add(conf.SelfServiceFlowRecoveryRequestLifespan(ctx)+time.Second))
rl2, _, err := adminSDK.IdentityAPI.
CreateRecoveryLinkForIdentity(t.Context()).
CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
}).
Execute()
require.NoError(t, err)
checkLink(t, rl2, time.Now().Add(conf.SelfServiceFlowRecoveryRequestLifespan(ctx)+time.Second))
recoveryUrl1, err := url.Parse(rl1.RecoveryLink)
require.NoError(t, err)
recoveryUrl2, err := url.Parse(rl2.RecoveryLink)
require.NoError(t, err)
token1 := recoveryUrl1.Query().Get("token")
require.NotEmpty(t, token1)
token2 := recoveryUrl2.Query().Get("token")
require.NotEmpty(t, token2)
require.NotEqual(t, token1, token2)
values := recoveryUrl1.Query()
values.Set("token", token2)
recoveryUrl1.RawQuery = values.Encode()
action := recoveryUrl1.String()
// Submit the modified link with token from rl2 and flow from rl1
res, err := publicTS.Client().Get(action)
require.NoError(t, err)
body := ioutilx.MustReadAll(res.Body)
action = gjson.GetBytes(body, "ui.action").String()
require.NotEmpty(t, action)
assert.Equal(t, "The recovery token is invalid or has already been used. Please retry the flow.", gjson.GetBytes(body, "ui.messages.0.text").String())
})
}
func TestRecovery(t *testing.T) {
ctx := t.Context()
conf, reg := pkg.NewFastRegistryWithMocks(t)
conf.MustSet(ctx, config.ViperKeySelfServiceStrategyConfig+".code.enabled", false)
conf.MustSet(ctx, config.ViperKeySelfServiceStrategyConfig+".link.enabled", true)
testhelpers.SetDefaultIdentitySchema(conf, "file://./stub/default.schema.json")
initViper(t, conf)
_ = testhelpers.NewRecoveryUIFlowEchoServer(t, reg)
_ = testhelpers.NewLoginUIFlowEchoServer(t, reg)
_ = testhelpers.NewSettingsUIFlowEchoServer(t, reg)
_ = testhelpers.NewErrorTestServer(t, reg)
public, _, publicRouter, _ := testhelpers.NewKratosServerWithCSRFAndRouters(t, reg)
expect := func(t *testing.T, hc *http.Client, isAPI, isSPA bool, values func(url.Values), c int) string {
if hc == nil {
hc = testhelpers.NewDebugClient(t)
if !isAPI {
hc = testhelpers.NewClientWithCookies(t)
hc.Transport = testhelpers.NewTransportWithLogger(testhelpers.NewTestTransport(t), t).RoundTripper
}
}
return testhelpers.SubmitRecoveryForm(t, isAPI, isSPA, hc, public, values, c,
testhelpers.ExpectURL(isAPI || isSPA, public.URL+recovery.RouteSubmitFlow, conf.SelfServiceFlowRecoveryUI(ctx).String()))
}
expectValidationError := func(t *testing.T, hc *http.Client, isAPI, isSPA bool, values func(url.Values)) string {
return expect(t, hc, isAPI, isSPA, values, testhelpers.ExpectStatusCode(isAPI || isSPA, http.StatusBadRequest, http.StatusOK))
}
expectSuccess := func(t *testing.T, hc *http.Client, isAPI, isSPA bool, values func(url.Values)) string {
return expect(t, hc, isAPI, isSPA, values, http.StatusOK)
}
t.Run("description=should set all the correct recovery payloads after submission", func(t *testing.T) {
body := expectSuccess(t, nil, false, false, func(v url.Values) {
v.Set("email", "test@ory.sh")
})
testhelpers.SnapshotTExcept(t, json.RawMessage(gjson.Get(body, "ui.nodes").String()), []string{"0.attributes.value"})
})
t.Run("description=should set all the correct recovery payloads", func(t *testing.T) {
c := testhelpers.NewClientWithCookies(t)
rs := testhelpers.GetRecoveryFlow(t, c, public)
testhelpers.SnapshotTExcept(t, rs.Ui.Nodes, []string{"0.attributes.value"})
assert.EqualValues(t, public.URL+recovery.RouteSubmitFlow+"?flow="+rs.Id, rs.Ui.Action)
assert.Empty(t, rs.Ui.Messages)
})
t.Run("description=should require an email to be sent", func(t *testing.T) {
check := func(t *testing.T, actual string) {
assert.EqualValues(t, node.LinkGroup, gjson.Get(actual, "active").String(), "%s", actual)
assert.EqualValues(t, "Property email is missing.",
gjson.Get(actual, "ui.nodes.#(attributes.name==email).messages.0.text").String(),
"%s", actual)
}
values := func(v url.Values) {
v.Del("email")
}
t.Run("type=browser", func(t *testing.T) {
check(t, expectValidationError(t, nil, false, false, values))
})
t.Run("type=spa", func(t *testing.T) {
check(t, expectValidationError(t, nil, false, true, values))
})
t.Run("type=api", func(t *testing.T) {
check(t, expectValidationError(t, nil, true, false, values))
})
})
t.Run("description=should require a valid email to be sent", func(t *testing.T) {
check := func(t *testing.T, actual string, value string) {
assert.EqualValues(t, node.LinkGroup, gjson.Get(actual, "active").String(), "%s", actual)
assert.EqualValues(t, "Enter a valid email address",
gjson.Get(actual, "ui.nodes.#(attributes.name==email).messages.0.text").String(),
"%s", actual)
}
for _, email := range []string{"\\", "asdf", "...", "aiacobelli.sec@gmail.com,alejandro.iacobelli@mercadolibre.com"} {
values := func(v url.Values) {
v.Set("email", email)
}
t.Run("type=browser", func(t *testing.T) {
check(t, expectValidationError(t, nil, false, false, values), email)
})
t.Run("type=spa", func(t *testing.T) {
check(t, expectValidationError(t, nil, false, true, values), email)
})
t.Run("type=api", func(t *testing.T) {
check(t, expectValidationError(t, nil, true, false, values), email)
})
}
})
t.Run("description=should try to submit the form while authenticated", func(t *testing.T) {
run := func(t *testing.T, flow string) {
isAPI := flow == "api"
isSPA := flow == "spa"
hc := testhelpers.NewDebugClient(t)
if !isAPI {
hc = testhelpers.NewClientWithCookies(t)
hc.Transport = testhelpers.NewTransportWithLogger(testhelpers.NewTestTransport(t), t).RoundTripper
}
var f *kratos.RecoveryFlow
if isAPI {
f = testhelpers.InitializeRecoveryFlowViaAPI(t, hc, public)
} else {
f = testhelpers.InitializeRecoveryFlowViaBrowser(t, hc, isSPA, public, nil)
}
v := testhelpers.SDKFormFieldsToURLValues(f.Ui.Nodes)
v.Set("email", "some-email@example.org")
v.Set("method", "link")
authClient := testhelpers.NewHTTPClientWithArbitrarySessionToken(ctx, t, reg)
if isAPI {
req := httptest.NewRequest("GET", "/sessions/whoami", nil).WithContext(contextx.WithConfigValue(ctx, config.ViperKeySessionLifespan, time.Hour))
s, err := testhelpers.NewActiveSession(req, reg,
&identity.Identity{ID: x.NewUUID(), State: identity.StateActive, NID: x.NewUUID()},
time.Now(),
identity.CredentialsTypePassword,
identity.AuthenticatorAssuranceLevel1,
)
require.NoError(t, err)
authClient = testhelpers.NewHTTPClientWithSessionCookieLocalhost(ctx, t, reg, s)
}
body, res := testhelpers.RecoveryMakeRequest(t, isAPI || isSPA, f, authClient, testhelpers.EncodeFormAsJSON(t, isAPI || isSPA, v))
if isAPI || isSPA {
require.EqualValuesf(t, http.StatusBadRequest, res.StatusCode, "%s", body)
assert.Contains(t, res.Request.URL.String(), recovery.RouteSubmitFlow, "%+v\n\t%s", res.Request, body)
assertx.EqualAsJSONExcept(t, recovery.ErrAlreadyLoggedIn(), json.RawMessage(gjson.Get(body, "error").Raw), nil)
} else {
assert.EqualValuesf(t, http.StatusOK, res.StatusCode, "%s", body)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceBrowserDefaultReturnTo(ctx).String(), "%+v\n\t%s", res.Request, body)
}
}
for _, f := range []string{"browser", "spa", "api"} {
t.Run("type="+f, func(t *testing.T) {
run(t, f)
})
}
})
t.Run("description=should try to recover an email that does not exist", func(t *testing.T) {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryNotifyUnknownRecipients, true)
t.Cleanup(func() {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryNotifyUnknownRecipients, false)
})
var email string
check := func(t *testing.T, actual string) {
assert.EqualValues(t, node.LinkGroup, gjson.Get(actual, "active").String(), "%s", actual)
assert.EqualValues(t, email, gjson.Get(actual, "ui.nodes.#(attributes.name==email).attributes.value").String(), "%s", actual)
assertx.EqualAsJSON(t, text.NewRecoveryEmailSent(), json.RawMessage(gjson.Get(actual, "ui.messages.0").Raw))
message := testhelpers.CourierExpectMessage(ctx, t, reg, email, "Account access attempted")
assert.Contains(t, message.Body, "If this was you, check if you signed up using a different address.")
}
values := func(v url.Values) {
v.Set("email", email)
}
t.Run("type=browser", func(t *testing.T) {
email = x.NewUUID().String() + "@ory.sh"
check(t, expectSuccess(t, nil, false, false, values))
})
t.Run("type=spa", func(t *testing.T) {
email = x.NewUUID().String() + "@ory.sh"
check(t, expectSuccess(t, nil, false, true, values))
})
t.Run("type=api", func(t *testing.T) {
email = x.NewUUID().String() + "@ory.sh"
check(t, expectSuccess(t, nil, true, false, values))
})
})
t.Run("description=should not be able to recover an inactive account", func(t *testing.T) {
for _, name := range []string{"browser", "spa", "api"} {
t.Run("case="+name, func(t *testing.T) {
recoveryEmail := "recovery_" + name + "@ory.sh"
id := createIdentityToRecover(t, reg, recoveryEmail)
expectSuccess(t, nil, name == "api", name == "spa", func(v url.Values) {
v.Set("email", recoveryEmail)
})
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account"), 1)
cl := testhelpers.NewClientWithCookies(t)
// Deactivate the identity
require.NoError(t, reg.Persister().GetConnection(t.Context()).RawQuery("UPDATE identities SET state=? WHERE id = ?", identity.StateInactive, id.ID).Exec())
res, err := cl.Get(recoveryLink)
require.NoError(t, err)
body := ioutilx.MustReadAll(res.Body)
assert.Equal(t, http.StatusOK, res.StatusCode)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowRecoveryUI(ctx).String())
assert.Equal(t, text.NewErrorValidationIdentityDisabled().Text, gjson.GetBytes(body, "ui.messages.0.text").String(), "%s", spew.Sdump(body))
})
}
})
t.Run("description=should recover an account", func(t *testing.T) {
check := func(t *testing.T, recoverySubmissionResponse, recoveryEmail, returnTo string) {
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
assert.EqualValues(t, node.LinkGroup, gjson.Get(recoverySubmissionResponse, "active").String(), "%s", recoverySubmissionResponse)
assert.EqualValues(t, recoveryEmail, gjson.Get(recoverySubmissionResponse, "ui.nodes.#(attributes.name==email).attributes.value").String(), "%s", recoverySubmissionResponse)
require.Len(t, gjson.Get(recoverySubmissionResponse, "ui.messages").Array(), 1, "%s", recoverySubmissionResponse)
assertx.EqualAsJSON(t, text.NewRecoveryEmailSent(), json.RawMessage(gjson.Get(recoverySubmissionResponse, "ui.messages.0").Raw))
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
assert.Contains(t, message.Body, "Recover access to your account by clicking the following link")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
assert.Contains(t, recoveryLink, public.URL+recovery.RouteSubmitFlow)
assert.Contains(t, recoveryLink, "token=")
cl := testhelpers.NewClientWithCookies(t)
res, err := cl.Get(recoveryLink)
require.NoError(t, err)
assert.Equal(t, http.StatusOK, res.StatusCode)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowSettingsUI(ctx).String())
body := ioutilx.MustReadAll(res.Body)
assert.Equal(t, text.NewRecoverySuccessful(clock.New(), time.Now().Add(time.Hour)).Text,
gjson.GetBytes(body, "ui.messages.0.text").String())
assert.Equal(t, returnTo, gjson.GetBytes(body, "return_to").String())
addr, err = reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.True(t, addr.Verified)
assert.NotEqual(t, sqlxx.NullTime{}, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusCompleted, addr.Status)
res, err = cl.Get(public.URL + session.RouteWhoami)
require.NoError(t, err)
body = x.MustReadAll(res.Body)
require.NoError(t, res.Body.Close())
assert.Equal(t, "link_recovery", gjson.GetBytes(body, "authentication_methods.0.method").String(), "%s", body)
assert.Equal(t, "aal1", gjson.GetBytes(body, "authenticator_assurance_level").String(), "%s", body)
}
t.Run("type=browser", func(t *testing.T) {
var wg sync.WaitGroup
wg.Add(1)
testhelpers.NewRecoveryAfterHookWebHookTarget(ctx, t, conf, func(t *testing.T, msg []byte) {
defer wg.Done()
assert.EqualValues(t, "recoverme1@ory.sh", gjson.GetBytes(msg, "identity.verifiable_addresses.0.value").String(), string(msg))
assert.EqualValues(t, true, gjson.GetBytes(msg, "identity.verifiable_addresses.0.verified").Bool(), string(msg))
assert.EqualValues(t, "completed", gjson.GetBytes(msg, "identity.verifiable_addresses.0.status").String(), string(msg))
})
email := "recoverme1@ory.sh"
createIdentityToRecover(t, reg, email)
check(t, expectSuccess(t, nil, false, false, func(v url.Values) {
v.Set("email", email)
}), email, "")
wg.Wait()
})
t.Run("description=should return browser to return url", func(t *testing.T) {
returnTo := public.URL + "/return-to"
conf.MustSet(ctx, config.ViperKeyURLsAllowedReturnToDomains, []string{returnTo})
for _, tc := range []struct {
desc string
returnTo string
f func(t *testing.T, client *http.Client) *kratos.RecoveryFlow
}{
{
desc: "should use return_to from recovery flow",
returnTo: returnTo,
f: func(t *testing.T, client *http.Client) *kratos.RecoveryFlow {
return testhelpers.InitializeRecoveryFlowViaBrowser(t, client, false, public, url.Values{"return_to": []string{returnTo}})
},
},
{
desc: "should use return_to from config",
returnTo: returnTo,
f: func(t *testing.T, client *http.Client) *kratos.RecoveryFlow {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryBrowserDefaultReturnTo, returnTo)
t.Cleanup(func() {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryBrowserDefaultReturnTo, "")
})
return testhelpers.InitializeRecoveryFlowViaBrowser(t, client, false, public, nil)
},
},
{
desc: "no return to",
returnTo: "",
f: func(t *testing.T, client *http.Client) *kratos.RecoveryFlow {
return testhelpers.InitializeRecoveryFlowViaBrowser(t, client, false, public, nil)
},
},
} {
t.Run(tc.desc, func(t *testing.T) {
email := testhelpers.RandomEmail()
createIdentityToRecover(t, reg, email)
hc := testhelpers.NewClientWithCookies(t)
hc.Transport = testhelpers.NewTransportWithLogger(testhelpers.NewTestTransport(t), t).RoundTripper
f := tc.f(t, hc)
time.Sleep(time.Millisecond) // add a bit of delay to allow `1ns` to time out.
formPayload := testhelpers.SDKFormFieldsToURLValues(f.Ui.Nodes)
formPayload.Set("email", email)
b, res := testhelpers.RecoveryMakeRequest(t, false, f, hc, testhelpers.EncodeFormAsJSON(t, false, formPayload))
assert.EqualValues(t, http.StatusOK, res.StatusCode, "%s", b)
expectedURL := testhelpers.ExpectURL(false, public.URL+recovery.RouteSubmitFlow, conf.SelfServiceFlowRecoveryUI(ctx).String())
assert.Contains(t, res.Request.URL.String(), expectedURL, "%+v\n\t%s", res.Request, b)
check(t, b, email, tc.returnTo)
})
}
})
t.Run("type=spa", func(t *testing.T) {
email := "recoverme3@ory.sh"
createIdentityToRecover(t, reg, email)
check(t, expectSuccess(t, nil, true, true, func(v url.Values) {
v.Set("email", email)
}), email, "")
})
t.Run("type=api", func(t *testing.T) {
email := "recoverme4@ory.sh"
createIdentityToRecover(t, reg, email)
check(t, expectSuccess(t, nil, true, false, func(v url.Values) {
v.Set("email", email)
}), email, "")
})
})
t.Run("description=should recover an account and set the csrf cookies", func(t *testing.T) {
check := func(t *testing.T, actual, recoveryEmail string, cl *http.Client, do func(*http.Client, *http.Request) (*http.Response, error)) {
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
cl.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}
res, err := do(cl, testhelpers.NewTestHTTPRequest(t, "GET", recoveryLink, nil))
require.NoError(t, err)
require.NoError(t, res.Body.Close())
assert.Equal(t, http.StatusSeeOther, res.StatusCode)
require.Len(t, cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)), 2)
cookies := spew.Sdump(cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)))
assert.Contains(t, cookies, nosurfx.CSRFTokenName)
assert.Contains(t, cookies, "ory_kratos_session")
returnTo, err := res.Location()
require.NoError(t, err)
assert.Contains(t, returnTo.String(), conf.SelfServiceFlowSettingsUI(ctx).String(), "we end up at the settings screen")
rl := urlx.ParseOrPanic(recoveryLink)
actualRes, err := cl.Get(public.URL + recovery.RouteGetFlow + "?id=" + rl.Query().Get("flow"))
require.NoError(t, err)
body := x.MustReadAll(actualRes.Body)
require.NoError(t, actualRes.Body.Close())
assert.Equal(t, http.StatusOK, actualRes.StatusCode, "%s", body)
assert.Equal(t, string(flow.StatePassedChallenge), gjson.GetBytes(body, "state").String(), "%s", body)
}
email := x.NewUUID().String() + "@ory.sh"
id := createIdentityToRecover(t, reg, email)
t.Run("case=unauthenticated", func(t *testing.T) {
values := func(v url.Values) {
v.Set("email", email)
}
check(t, expectSuccess(t, nil, false, false, values), email, testhelpers.NewClientWithCookies(t), (*http.Client).Do)
})
t.Run("case=already logged into another account", func(t *testing.T) {
values := func(v url.Values) {
v.Set("email", email)
}
check(t, expectSuccess(t, nil, false, false, values), email, testhelpers.NewClientWithCookies(t), func(cl *http.Client, req *http.Request) (*http.Response, error) {
_, res := testhelpers.MockMakeAuthenticatedRequestWithClient(t, reg, conf, publicRouter, req, cl)
return res, nil
})
})
t.Run("case=already logged into the account", func(t *testing.T) {
values := func(v url.Values) {
v.Set("email", email)
}
cl := testhelpers.NewHTTPClientWithIdentitySessionCookie(ctx, t, reg, id)
check(t, expectSuccess(t, nil, false, false, values), email, cl, func(_ *http.Client, req *http.Request) (*http.Response, error) {
_, res := testhelpers.MockMakeAuthenticatedRequestWithClientAndID(t, reg, conf, publicRouter, req, cl, id)
return res, nil
})
})
})
t.Run("description=should recover and invalidate all other sessions if hook is set", func(t *testing.T) {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRecoveryAfter, config.HookGlobal), []config.SelfServiceHook{{Name: "revoke_active_sessions"}})
t.Cleanup(func() {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRegistrationAfter, identity.CredentialsTypePassword.String()), nil)
})
recoveryEmail := strings.ToLower(testhelpers.RandomEmail())
email := recoveryEmail
id := createIdentityToRecover(t, reg, email)
req := httptest.NewRequest("GET", "/sessions/whoami", nil)
sess, err := testhelpers.NewActiveSession(req, reg, id, time.Now(), identity.CredentialsTypePassword, identity.AuthenticatorAssuranceLevel1)
require.NoError(t, err)
require.NoError(t, reg.SessionPersister().UpsertSession(t.Context(), sess))
actualSession, err := reg.SessionPersister().GetSession(t.Context(), sess.ID, session.ExpandNothing)
require.NoError(t, err)
assert.True(t, actualSession.IsActive())
check := func(t *testing.T, actual string) {
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
cl := testhelpers.NewClientWithCookies(t)
cl.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}
res, err := cl.Get(recoveryLink)
require.NoError(t, err)
require.NoError(t, res.Body.Close())
assert.Equal(t, http.StatusSeeOther, res.StatusCode)
require.Len(t, cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)), 2)
cookies := spew.Sdump(cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)))
assert.Contains(t, cookies, "ory_kratos_session")
actualSession, err := reg.SessionPersister().GetSession(t.Context(), sess.ID, session.ExpandNothing)
require.NoError(t, err)
assert.False(t, actualSession.IsActive())
}
values := func(v url.Values) {
v.Set("email", recoveryEmail)
}
check(t, expectSuccess(t, nil, false, false, values))
})
t.Run("description=should not be able to use an invalid link", func(t *testing.T) {
c := testhelpers.NewClientWithCookies(t)
f := testhelpers.InitializeRecoveryFlowViaBrowser(t, c, false, public, nil)
res, err := c.Get(f.Ui.Action + "&token=i-do-not-exist")
require.NoError(t, err)
assert.Equal(t, http.StatusOK, res.StatusCode)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowRecoveryUI(ctx).String()+"?flow=")
rs, _, err := testhelpers.NewSDKCustomClient(public, c).FrontendAPI.GetRecoveryFlow(t.Context()).Id(res.Request.URL.Query().Get("flow")).Execute()
require.NoError(t, err)
require.Len(t, rs.Ui.Messages, 1)
assert.Equal(t, "The recovery token is invalid or has already been used. Please retry the flow.", rs.Ui.Messages[0].Text)
})
t.Run("description=should not be able to use an outdated link", func(t *testing.T) {
recoveryEmail := "recoverme5@ory.sh"
createIdentityToRecover(t, reg, recoveryEmail)
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryRequestLifespan, time.Millisecond*200)
t.Cleanup(func() {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryRequestLifespan, time.Minute)
})
c := testhelpers.NewClientWithCookies(t)
rs := testhelpers.GetRecoveryFlow(t, c, public)
time.Sleep(time.Millisecond * 201)
res, err := c.PostForm(rs.Ui.Action, url.Values{"email": {recoveryEmail}})
require.NoError(t, err)
assert.EqualValues(t, http.StatusOK, res.StatusCode)
assert.NotContains(t, res.Request.URL.String(), "flow="+rs.Id)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowRecoveryUI(ctx).String())
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
})
t.Run("description=should not be able to use an outdated flow", func(t *testing.T) {
recoveryEmail := "recoverme6@ory.sh"
createIdentityToRecover(t, reg, recoveryEmail)
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryRequestLifespan, time.Millisecond*200)
t.Cleanup(func() {
conf.MustSet(ctx, config.ViperKeySelfServiceRecoveryRequestLifespan, time.Minute)
})
c := testhelpers.NewClientWithCookies(t)
body := expectSuccess(t, c, false, false, func(v url.Values) {
v.Set("email", recoveryEmail)
})
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
assert.Contains(t, message.Body, "Recover access to your account by clicking the following link")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
time.Sleep(time.Millisecond * 201)
res, err := c.Get(recoveryLink)
require.NoError(t, err)
assert.EqualValues(t, http.StatusOK, res.StatusCode)
assert.Contains(t, res.Request.URL.String(), conf.SelfServiceFlowRecoveryUI(ctx).String())
assert.NotContains(t, res.Request.URL.String(), gjson.Get(body, "id").String())
rs, _, err := testhelpers.NewSDKCustomClient(public, c).FrontendAPI.GetRecoveryFlow(t.Context()).Id(res.Request.URL.Query().Get("flow")).Execute()
require.NoError(t, err)
require.Len(t, rs.Ui.Messages, 1)
assert.Contains(t, rs.Ui.Messages[0].Text, "The recovery flow expired")
addr, err := reg.IdentityPool().FindVerifiableAddressByValue(t.Context(), identity.AddressTypeEmail, recoveryEmail)
assert.NoError(t, err)
assert.False(t, addr.Verified)
assert.Nil(t, addr.VerifiedAt)
assert.Equal(t, identity.VerifiableAddressStatusPending, addr.Status)
})
t.Run("description=should recover if post recovery hook is successful", func(t *testing.T) {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRecoveryAfter, config.HookGlobal), []config.SelfServiceHook{{Name: "err", Config: []byte(`{}`)}})
t.Cleanup(func() {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRecoveryAfter, config.HookGlobal), nil)
})
recoveryEmail := testhelpers.RandomEmail()
createIdentityToRecover(t, reg, recoveryEmail)
check := func(t *testing.T, actual string) {
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
cl := testhelpers.NewClientWithCookies(t)
cl.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}
res, err := cl.Get(recoveryLink)
require.NoError(t, err)
require.NoError(t, res.Body.Close())
assert.Equal(t, http.StatusSeeOther, res.StatusCode)
require.Len(t, cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)), 2)
cookies := spew.Sdump(cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)))
assert.Contains(t, cookies, "ory_kratos_session")
}
values := func(v url.Values) {
v.Set("email", recoveryEmail)
}
check(t, expectSuccess(t, nil, false, false, values))
})
t.Run("description=should not be able to recover if post recovery hook fails", func(t *testing.T) {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRecoveryAfter, config.HookGlobal), []config.SelfServiceHook{{Name: "err", Config: []byte(`{"ExecutePostRecoveryHook": "err"}`)}})
t.Cleanup(func() {
conf.MustSet(ctx, config.HookStrategyKey(config.ViperKeySelfServiceRecoveryAfter, config.HookGlobal), nil)
})
recoveryEmail := testhelpers.RandomEmail()
createIdentityToRecover(t, reg, recoveryEmail)
check := func(t *testing.T, actual string) {
message := testhelpers.CourierExpectMessage(ctx, t, reg, recoveryEmail, "Recover access to your account")
recoveryLink := testhelpers.CourierExpectLinkInMessage(t, message, 1)
cl := testhelpers.NewClientWithCookies(t)
cl.CheckRedirect = func(req *http.Request, via []*http.Request) error {
return http.ErrUseLastResponse
}
res, err := cl.Get(recoveryLink)
require.NoError(t, err)
require.NoError(t, res.Body.Close())
assert.Equal(t, http.StatusSeeOther, res.StatusCode)
require.Len(t, cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)), 1)
cookies := spew.Sdump(cl.Jar.Cookies(urlx.ParseOrPanic(public.URL)))
assert.NotContains(t, cookies, "ory_kratos_session")
}
values := func(v url.Values) {
v.Set("email", recoveryEmail)
}
check(t, expectSuccess(t, nil, false, false, values))
})
}
func TestDisabledEndpoint(t *testing.T) {
ctx := t.Context()
conf, reg := pkg.NewFastRegistryWithMocks(t)
initViper(t, conf)
conf.MustSet(ctx, config.ViperKeySelfServiceStrategyConfig+"."+string(recovery.RecoveryStrategyLink)+".enabled", false)
conf.MustSet(ctx, config.ViperKeySelfServiceStrategyConfig+"."+string(recovery.RecoveryStrategyCode)+".enabled", false)
publicTS, adminTS := testhelpers.NewKratosServer(t, reg)
adminSDK := testhelpers.NewSDKClient(adminTS)
_ = testhelpers.NewErrorTestServer(t, reg)
t.Run("role=admin", func(t *testing.T) {
t.Run("description=can not create recovery link when link method is disabled", func(t *testing.T) {
id := identity.Identity{Traits: identity.Traits(`{"email":"recovery-endpoint-disabled@ory.sh"}`)}
require.NoError(t, reg.IdentityManager().Create(t.Context(),
&id, identity.ManagerAllowWriteProtectedTraits))
rl, _, err := adminSDK.IdentityAPI.CreateRecoveryLinkForIdentity(t.Context()).CreateRecoveryLinkForIdentityBody(kratos.CreateRecoveryLinkForIdentityBody{
IdentityId: id.ID.String(),
}).Execute()
assert.Nil(t, rl)
require.IsType(t, new(kratos.GenericOpenAPIError), err, "%s", err)
br, _ := err.(*kratos.GenericOpenAPIError)
assert.Contains(t, string(br.Body()), "This endpoint was disabled by system administrator", "%s", br.Body())
})
})
t.Run("role=public", func(t *testing.T) {
c := testhelpers.NewClientWithCookies(t)
t.Run("description=can not recover an account by get request when link method is disabled", func(t *testing.T) {
f := testhelpers.PersistNewRecoveryFlow(t, nil, conf, reg)
u := publicTS.URL + recovery.RouteSubmitFlow + "?flow=" + f.ID.String() + "&token=endpoint-disabled"
res, err := c.Get(u)
require.NoError(t, err)
assert.Equal(t, http.StatusOK, res.StatusCode)
b := ioutilx.MustReadAll(res.Body)
assert.Contains(t, string(b), "This endpoint was disabled by system administrator")
})
t.Run("description=can not recover an account by post request when link method is disabled", func(t *testing.T) {
f := testhelpers.PersistNewRecoveryFlow(t, nil, conf, reg)
u := publicTS.URL + recovery.RouteSubmitFlow + "?flow=" + f.ID.String()
res, err := c.PostForm(u, url.Values{"email": {"email@ory.sh"}, "method": {"link"}})
require.NoError(t, err)
assert.Equal(t, http.StatusOK, res.StatusCode)
b := ioutilx.MustReadAll(res.Body)
assert.Contains(t, string(b), "This endpoint was disabled by system administrator")
})
})
}