feat: allow SMS as passwordless login method

This patch allows Ory Kratos to use the SMS gateway for login and registration with code via SMS.

cmd/clidoc/main.go

@@ -162,7 +162,7 @@ func init() {
 		"NewInfoSelfServiceLoginContinue":                         text.NewInfoSelfServiceLoginContinue(),
 		"NewErrorValidationSuchNoWebAuthnUser":                    text.NewErrorValidationSuchNoWebAuthnUser(),
 		"NewRegistrationEmailWithCodeSent":                        text.NewRegistrationEmailWithCodeSent(),
-		"NewLoginEmailWithCodeSent":                               text.NewLoginEmailWithCodeSent(),
+		"NewLoginCodeSent":                                        text.NewLoginCodeSent(),
 		"NewErrorValidationRegistrationCodeInvalidOrAlreadyUsed":  text.NewErrorValidationRegistrationCodeInvalidOrAlreadyUsed(),
 		"NewErrorValidationLoginCodeInvalidOrAlreadyUsed":         text.NewErrorValidationLoginCodeInvalidOrAlreadyUsed(),
 		"NewErrorValidationNoCodeUser":                            text.NewErrorValidationNoCodeUser(),

courier/sms_templates.go

@@ -40,6 +40,12 @@ func NewSMSTemplateFromMessage(d template.Dependencies, m Message) (SMSTemplate,
 			return nil, err
 		}
 		return sms.NewLoginCodeValid(d, &t), nil
+	case template.TypeRegistrationCodeValid:
+		var t sms.RegistrationCodeValidModel
+		if err := json.Unmarshal(m.TemplateData, &t); err != nil {
+			return nil, err
+		}
+		return sms.NewRegistrationCodeValid(d, &t), nil
 
 	default:
 		return nil, errors.Errorf("received unexpected message template type: %s", m.TemplateType)

courier/template/courier/builtin/templates/registration_code/valid/sms.body.gotmpl

@@ -0,0 +1 @@
+Your registration code is: {{ .RegistrationCode }}

courier/template/sms/registration_code_valid.go

@@ -0,0 +1,54 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package sms
+
+import (
+	"context"
+	"encoding/json"
+	"os"
+
+	"github.com/ory/kratos/courier/template"
+)
+
+type (
+	RegistrationCodeValid struct {
+		deps  template.Dependencies
+		model *RegistrationCodeValidModel
+	}
+	RegistrationCodeValidModel struct {
+		To               string                 `json:"to"`
+		RegistrationCode string                 `json:"registration_code"`
+		Identity         map[string]interface{} `json:"identity"`
+		RequestURL       string                 `json:"request_url"`
+		TransientPayload map[string]interface{} `json:"transient_payload"`
+	}
+)
+
+func NewRegistrationCodeValid(d template.Dependencies, m *RegistrationCodeValidModel) *RegistrationCodeValid {
+	return &RegistrationCodeValid{deps: d, model: m}
+}
+
+func (t *RegistrationCodeValid) PhoneNumber() (string, error) {
+	return t.model.To, nil
+}
+
+func (t *RegistrationCodeValid) SMSBody(ctx context.Context) (string, error) {
+	return template.LoadText(
+		ctx,
+		t.deps,
+		os.DirFS(t.deps.CourierConfig().CourierTemplatesRoot(ctx)),
+		"registration_code/valid/sms.body.gotmpl",
+		"registration_code/valid/sms.body*",
+		t.model,
+		t.deps.CourierConfig().CourierSMSTemplatesRegistrationCodeValid(ctx).Body.PlainText,
+	)
+}
+
+func (t *RegistrationCodeValid) MarshalJSON() ([]byte, error) {
+	return json.Marshal(t.model)
+}
+
+func (t *RegistrationCodeValid) TemplateType() template.TemplateType {
+	return template.TypeRegistrationCodeValid
+}

courier/template/sms/registration_code_valid_test.go

@@ -0,0 +1,37 @@
+// Copyright © 2023 Ory Corp
+// SPDX-License-Identifier: Apache-2.0
+
+package sms_test
+
+import (
+	"context"
+	"fmt"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
+
+	"github.com/ory/kratos/courier/template/sms"
+	"github.com/ory/kratos/internal"
+)
+
+func TestNewRegistrationCodeValid(t *testing.T) {
+	_, reg := internal.NewFastRegistryWithMocks(t)
+
+	const (
+		expectedPhone = "+12345678901"
+		otp           = "012345"
+	)
+
+	tpl := sms.NewRegistrationCodeValid(reg, &sms.RegistrationCodeValidModel{To: expectedPhone, RegistrationCode: otp})
+
+	expectedBody := fmt.Sprintf("Your registration code is: %s\n", otp)
+
+	actualBody, err := tpl.SMSBody(context.Background())
+	require.NoError(t, err)
+	assert.Equal(t, expectedBody, actualBody)
+
+	actualPhone, err := tpl.PhoneNumber()
+	require.NoError(t, err)
+	assert.Equal(t, expectedPhone, actualPhone)
+}

driver/config/config.go

@@ -69,6 +69,7 @@ const (
 	ViperKeyCourierTemplatesVerificationCodeValidEmail       = "courier.templates.verification_code.valid.email"
 	ViperKeyCourierTemplatesVerificationCodeValidSMS         = "courier.templates.verification_code.valid.sms"
 	ViperKeyCourierTemplatesLoginCodeValidSMS                = "courier.templates.login_code.valid.sms"
+	ViperKeyCourierTemplatesRegistrationCodeValidSMS         = "courier.templates.registration_code.valid.sms"
 	ViperKeyCourierDeliveryStrategy                          = "courier.delivery_strategy"
 	ViperKeyCourierHTTPRequestConfig                         = "courier.http.request_config"
 	ViperKeyCourierTemplatesLoginCodeValidEmail              = "courier.templates.login_code.valid.email"
@@ -322,6 +323,7 @@ type (
 		CourierTemplatesRegistrationCodeValid(ctx context.Context) *CourierEmailTemplate
 		CourierSMSTemplatesVerificationCodeValid(ctx context.Context) *CourierSMSTemplate
 		CourierSMSTemplatesLoginCodeValid(ctx context.Context) *CourierSMSTemplate
+		CourierSMSTemplatesRegistrationCodeValid(ctx context.Context) *CourierSMSTemplate
 		CourierMessageRetries(ctx context.Context) int
 		CourierWorkerPullCount(ctx context.Context) int
 		CourierWorkerPullWait(ctx context.Context) time.Duration
@@ -1160,6 +1162,10 @@ func (p *Config) CourierSMSTemplatesLoginCodeValid(ctx context.Context) *Courier
 	return p.CourierSMSTemplatesHelper(ctx, ViperKeyCourierTemplatesLoginCodeValidSMS)
 }
 
+func (p *Config) CourierSMSTemplatesRegistrationCodeValid(ctx context.Context) *CourierSMSTemplate {
+	return p.CourierSMSTemplatesHelper(ctx, ViperKeyCourierTemplatesRegistrationCodeValidSMS)
+}
+
 func (p *Config) CourierTemplatesLoginCodeValid(ctx context.Context) *CourierEmailTemplate {
 	return p.CourierEmailTemplatesHelper(ctx, ViperKeyCourierTemplatesLoginCodeValidEmail)
 }

embedx/config.schema.json

@@ -2043,6 +2043,9 @@
                   "properties": {
                     "email": {
                       "$ref": "#/definitions/emailCourierTemplate"
+                    },
+                    "sms": {
+                      "$ref": "#/definitions/smsCourierTemplate"
                     }
                   },
                   "required": ["email"]

selfservice/strategy/code/strategy.go

@@ -352,7 +352,7 @@ func (s *Strategy) populateEmailSentFlow(ctx context.Context, f flow.Flow) error
 	case flow.LoginFlow:
 		route = login.RouteSubmitFlow
 		codeMetaLabel = text.NewInfoNodeLabelLoginCode()
-		message = text.NewLoginEmailWithCodeSent()
+		message = text.NewLoginCodeSent()
 
 		// preserve the login identifier that was submitted
 		// so we can retry the code flow with the same data

selfservice/strategy/code/strategy_registration_test.go

@@ -372,7 +372,7 @@ func TestRegistrationCodeStrategy(t *testing.T) {
 						} else {
 							require.NotEmptyf(t, csrfToken, "expected to find the csrf_token but got %s", body)
 						}
-						require.Containsf(t, gjson.Get(body, "ui.messages").String(), "An email containing a code has been sent to the email address you provided.", "%s", body)
+						require.Containsf(t, gjson.Get(body, "ui.messages").String(), "A code has been sent to the address(es) you provided", "%s", body)
 					})
 
 					// get the new code from email

test/e2e/cypress/integration/profiles/code/login/error.spec.ts

@@ -80,7 +80,7 @@ context("Login error messages with code method", () => {
 
         cy.get('[data-testid="ui/message/1010014"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address you provided",
         )
 
         cy.get(Selectors[app]["code"]).type("123456")

test/e2e/cypress/integration/profiles/code/registration/error.spec.ts

@@ -92,7 +92,7 @@ context("Registration error messages with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         if (app !== "express") {
@@ -133,7 +133,7 @@ context("Registration error messages with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         cy.removeAttribute([Selectors[app]["code"]], "required")
@@ -202,7 +202,7 @@ context("Registration error messages with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         cy.getRegistrationCodeFromEmail(email).then((code) => {

test/e2e/cypress/integration/profiles/two-steps/registration/code.spec.ts

@@ -106,7 +106,7 @@ context("Registration success with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         cy.getRegistrationCodeFromEmail(email).then((code) =>
@@ -189,7 +189,7 @@ context("Registration success with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         cy.getRegistrationCodeFromEmail(email).should((code) => {
@@ -236,7 +236,7 @@ context("Registration success with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         cy.getRegistrationCodeFromEmail(email).should((code) => {
@@ -307,7 +307,7 @@ context("Registration success with code method", () => {
         cy.submitCodeForm(app)
         cy.get('[data-testid="ui/message/1040005"]').should(
           "contain",
-          "An email containing a code has been sent to the email address you provided",
+          "A code has been sent to the address(es) you provided",
         )
 
         // intentionally use email 1 to sign up for the account

text/id.go

@@ -23,7 +23,7 @@ const (
 	InfoSelfServiceLoginContinueWebAuthn                         // 1010011
 	InfoSelfServiceLoginWebAuthnPasswordless                     // 1010012
 	InfoSelfServiceLoginContinue                                 // 1010013
-	InfoSelfServiceLoginEmailWithCodeSent                        // 1010014
+	InfoSelfServiceLoginCodeSent                                 // 1010014
 	InfoSelfServiceLoginCode                                     // 1010015
 	InfoSelfServiceLoginLink                                     // 1010016
 	InfoSelfServiceLoginAndLink                                  // 1010017

text/message_login.go

@@ -224,11 +224,11 @@ func NewInfoSelfServiceLoginContinue() *Message {
 	}
 }
 
-func NewLoginEmailWithCodeSent() *Message {
+func NewLoginCodeSent() *Message {
 	return &Message{
-		ID:   InfoSelfServiceLoginEmailWithCodeSent,
+		ID:   InfoSelfServiceLoginCodeSent,
 		Type: Info,
-		Text: "An email containing a code has been sent to the email address you provided. If you have not received an email, check the spelling of the address and retry the login.",
+		Text: "A code has been sent to the address you provided. If you have not received an message, check the spelling of the address and retry the login.",
 	}
 }
 

text/message_registration.go

@@ -84,7 +84,7 @@ func NewRegistrationEmailWithCodeSent() *Message {
 	return &Message{
 		ID:   InfoSelfServiceRegistrationEmailWithCodeSent,
 		Type: Info,
-		Text: "An email containing a code has been sent to the email address you provided. If you have not received an email, check the spelling of the address and retry the registration.",
+		Text: "A code has been sent to the address(es) you provided. If you have not received an message, check the spelling of the address and retry the registration.",
 	}
 }