feat: sms-login initial commit

cmd/clidoc/main.go

@@ -68,6 +68,7 @@ func init() {
 		"NewInfoSelfServiceRemoveWebAuthn":                        text.NewInfoSelfServiceRemoveWebAuthn("{name}", aSecondAgo),
 		"NewErrorValidationVerificationFlowExpired":               text.NewErrorValidationVerificationFlowExpired(-time.Second),
 		"NewInfoSelfServiceVerificationSuccessful":                text.NewInfoSelfServiceVerificationSuccessful(),
+		"NewInfoSelfServicePhoneVerificationSuccessful":           text.NewInfoSelfServicePhoneVerificationSuccessful(),
 		"NewVerificationEmailSent":                                text.NewVerificationEmailSent(),
 		"NewErrorValidationVerificationTokenInvalidOrAlreadyUsed": text.NewErrorValidationVerificationTokenInvalidOrAlreadyUsed(),
 		"NewErrorValidationVerificationRetrySuccess":              text.NewErrorValidationVerificationRetrySuccess(),
@@ -114,7 +115,11 @@ func init() {
 		"NewErrorValidationRecoveryTokenInvalidOrAlreadyUsed":     text.NewErrorValidationRecoveryTokenInvalidOrAlreadyUsed(),
 		"NewErrorValidationRecoveryRetrySuccess":                  text.NewErrorValidationRecoveryRetrySuccess(),
 		"NewErrorValidationRecoveryStateFailure":                  text.NewErrorValidationRecoveryStateFailure(),
+		"NewErrorValidationInvalidCode":                           text.NewErrorValidationInvalidCode(),
+		"NewErrorCodeSent":                                        text.NewErrorCodeSent(),
 		"NewInfoNodeInputEmail":                                   text.NewInfoNodeInputEmail(),
+		"NewInfoNodeInputPhone":                                   text.NewInfoNodeInputPhone(),
+		"NewVerificationPhoneSent":                                text.NewVerificationPhoneSent(),
 	}
 }
 

courier/courier.go

@@ -1,5 +1,7 @@
 package courier
 
+//go:generate mockgen -destination=mocks/mock_courier.go -package=mocks github.com/ory/kratos/courier Courier
+
 import (
 	"context"
 	"time"
@@ -79,9 +81,15 @@ func (c *courier) Work(ctx context.Context) error {
 
 func (c *courier) watchMessages(ctx context.Context, errChan chan error) {
 	for {
-		if err := backoff.Retry(func() error {
-			return c.DispatchQueue(ctx)
-		}, backoff.NewExponentialBackOff()); err != nil {
+		if err := backoff.RetryNotify(
+			func() error {
+				return c.DispatchQueue(ctx)
+			},
+			backoff.NewExponentialBackOff(),
+			func(err error, t time.Duration) {
+				c.deps.Logger().WithError(err).Error("Courier DispatchQueue error")
+			},
+		); err != nil {
 			errChan <- err
 			return
 		}

courier/courier_dispatcher.go

@@ -7,20 +7,28 @@ import (
 )
 
 func (c *courier) DispatchMessage(ctx context.Context, msg Message) error {
+	messageStatus := MessageStatusSent
+	logMessage := "Courier sent out message."
+
 	switch msg.Type {
 	case MessageTypeEmail:
 		if err := c.dispatchEmail(ctx, msg); err != nil {
 			return err
 		}
 	case MessageTypePhone:
 		if err := c.dispatchSMS(ctx, msg); err != nil {
-			return err
+			if m, ok := err.(*MessageRejectedError); ok {
+				messageStatus = MessageStatusRejected
+				logMessage = m.Error()
+			} else {
+				return err
+			}
 		}
 	default:
 		return errors.Errorf("received unexpected message type: %d", msg.Type)
 	}
 
-	if err := c.deps.CourierPersister().SetMessageStatus(ctx, msg.ID, MessageStatusSent); err != nil {
+	if err := c.deps.CourierPersister().SetMessageStatus(ctx, msg.ID, messageStatus); err != nil {
 		c.deps.Logger().
 			WithError(err).
 			WithField("message_id", msg.ID).
@@ -33,7 +41,7 @@ func (c *courier) DispatchMessage(ctx context.Context, msg Message) error {
 		WithField("message_type", msg.Type).
 		WithField("message_template_type", msg.TemplateType).
 		WithField("message_subject", msg.Subject).
-		Debug("Courier sent out message.")
+		Debug(logMessage)
 
 	return nil
 }

courier/email_templates.go

@@ -28,6 +28,7 @@ const (
 	TypeVerificationValid   TemplateType = "verification_valid"
 	TypeOTP                 TemplateType = "otp"
 	TypeTestStub            TemplateType = "stub"
+	TypeCode                TemplateType = "code"
 )
 
 func GetEmailTemplateType(t EmailTemplate) (TemplateType, error) {

courier/error.go

@@ -0,0 +1,18 @@
+package courier
+
+import (
+	"fmt"
+	"net/http"
+)
+
+type MessageRejectedError struct {
+	StatusCode   int
+	ResponseBody string
+}
+
+func NewMessageRejectedError(statusCode int, responseBody string) error {
+	return &MessageRejectedError{StatusCode: statusCode, ResponseBody: responseBody}
+}
+func (m *MessageRejectedError) Error() string {
+	return fmt.Sprintf("Status: %s, body: %s", http.StatusText(m.StatusCode), m.ResponseBody)
+}

courier/message.go

@@ -15,6 +15,7 @@ const (
 	MessageStatusQueued MessageStatus = iota + 1
 	MessageStatusSent
 	MessageStatusProcessing
+	MessageStatusRejected // Service won't send this message for some unrecoverable reasons (incorrect phone number e.g.)
 )
 
 type MessageType int

courier/sms.go

@@ -3,6 +3,7 @@ package courier
 import (
 	"context"
 	"encoding/json"
+	"io"
 	"net/http"
 
 	"github.com/pkg/errors"
@@ -105,8 +106,18 @@ func (c *courier) dispatchSMS(ctx context.Context, msg Message) error {
 	switch res.StatusCode {
 	case http.StatusOK:
 	case http.StatusCreated:
+	case http.StatusBadRequest:
+		b, err := io.ReadAll(res.Body)
+		if err != nil {
+			return err
+		}
+		return NewMessageRejectedError(res.StatusCode, string(b))
 	default:
-		return errors.New(http.StatusText(res.StatusCode))
+		b, err := io.ReadAll(res.Body)
+		if err != nil {
+			return err
+		}
+		return errors.Errorf("Status: %s, body: %s", http.StatusText(res.StatusCode), string(b))
 	}
 
 	return nil

courier/sms_templates.go

@@ -21,6 +21,8 @@ func SMSTemplateType(t SMSTemplate) (TemplateType, error) {
 		return TypeOTP, nil
 	case *sms.TestStub:
 		return TypeTestStub, nil
+	case *sms.CodeMessage:
+		return TypeCode, nil
 	default:
 		return "", errors.Errorf("unexpected template type")
 	}
@@ -40,6 +42,12 @@ func NewSMSTemplateFromMessage(d Dependencies, m Message) (SMSTemplate, error) {
 			return nil, err
 		}
 		return sms.NewTestStub(d, &t), nil
+	case TypeCode:
+		var t sms.CodeMessageModel
+		if err := json.Unmarshal(m.TemplateData, &t); err != nil {
+			return nil, err
+		}
+		return sms.NewCodeMessage(d, &t), nil
 	default:
 		return nil, errors.Errorf("received unexpected message template type: %s", m.TemplateType)
 	}

courier/sms_templates_test.go

@@ -33,6 +33,7 @@ func TestNewSMSTemplateFromMessage(t *testing.T) {
 	for tmplType, expectedTmpl := range map[courier.TemplateType]courier.SMSTemplate{
 		courier.TypeOTP:      sms.NewOTPMessage(reg, &sms.OTPMessageModel{To: "+12345678901"}),
 		courier.TypeTestStub: sms.NewTestStub(reg, &sms.TestStubModel{To: "+12345678901", Body: "test body"}),
+		courier.TypeCode:     sms.NewCodeMessage(reg, &sms.CodeMessageModel{To: "+12345678901"}),
 	} {
 		t.Run(fmt.Sprintf("case=%s", tmplType), func(t *testing.T) {
 			tmplData, err := json.Marshal(expectedTmpl)

courier/sms_test.go

@@ -27,11 +27,11 @@ func TestQueueSMS(t *testing.T) {
 	expectedSMS := []*sms.TestStubModel{
 		{
 			To:   "+12065550101",
-			Body: "test-sms-body-1",
+			Body: "test-code-body-1",
 		},
 		{
 			To:   "+12065550102",
-			Body: "test-sms-body-2",
+			Body: "test-code-body-2",
 		},
 	}
 

courier/template/courier/builtin/templates/login/sms.body.gotmpl

@@ -0,0 +1 @@
+code {{ .Code }}

courier/template/courier/builtin/templates/test_stub/sms.body.gotmpl

@@ -0,0 +1 @@
+stub sms body {{ .Body }}

courier/template/sms/code_login.go

@@ -0,0 +1,35 @@
+package sms
+
+import (
+	"context"
+	"encoding/json"
+	"github.com/ory/kratos/courier/template"
+	"os"
+)
+
+type (
+	CodeMessage struct {
+		d template.Dependencies
+		m *CodeMessageModel
+	}
+	CodeMessageModel struct {
+		To   string
+		Code string
+	}
+)
+
+func NewCodeMessage(d template.Dependencies, m *CodeMessageModel) *CodeMessage {
+	return &CodeMessage{d: d, m: m}
+}
+
+func (t *CodeMessage) PhoneNumber() (string, error) {
+	return t.m.To, nil
+}
+
+func (t *CodeMessage) SMSBody(ctx context.Context) (string, error) {
+	return template.LoadText(ctx, t.d, os.DirFS(t.d.CourierConfig(ctx).CourierTemplatesRoot()), "login/sms.body.gotmpl", "login/sms.body*", t.m, "")
+}
+
+func (t *CodeMessage) MarshalJSON() ([]byte, error) {
+	return json.Marshal(t.m)
+}

driver/clock/clock.go

@@ -0,0 +1,9 @@
+package clock
+
+import (
+	"github.com/benbjohnson/clock"
+)
+
+type Provider interface {
+	Clock() clock.Clock
+}

driver/config/config.go

@@ -164,6 +164,8 @@ const (
 	ViperKeyWebAuthnRPIcon                                   = "selfservice.methods.webauthn.config.rp.issuer"
 	ViperKeyClientHTTPNoPrivateIPRanges                      = "clients.http.disallow_private_ip_ranges"
 	ViperKeyVersion                                          = "version"
+	CodeMaxAttempts                                          = "selfservice.methods.code.config.max_attempts"
+	CodeLifespan                                             = "selfservice.methods.code.config.lifespan"
 )
 
 const (
@@ -1234,3 +1236,11 @@ func (p *Config) getTSLCertificates(daemon, certBase64, keyBase64, certPath, key
 	p.l.Infof("TLS has not been configured for %s, skipping", daemon)
 	return nil
 }
+
+func (p *Config) SelfServiceCodeMaxAttempts() int {
+	return p.p.Int(CodeMaxAttempts)
+}
+
+func (p *Config) SelfServiceCodeLifespan() time.Duration {
+	return p.p.DurationF(CodeLifespan, time.Hour)
+}