chore: rename phone channel to sms

contrib/quickstart/kratos/phone-password/identity.schema.json

@@ -19,7 +19,7 @@
               }
             },
             "verification": {
-              "via": "phone"
+              "via": "sms"
             }
           }
         }

contrib/quickstart/kratos/phone-password/kratos.yml

@@ -96,12 +96,12 @@ identity:
 
 courier:
   channels:
-    - id: phone
+    - id: sms
       type: http
       request_config:
         url: https://api.twilio.com/2010-04-01/Accounts/AXXXXXXXXXXXXXX/Messages.json
         method: POST
-        body: base64://ZnVuY3Rpb24oY3R4KSB7CkJvZHk6IGN0eC5ib2R5LApUbzogY3R4LnRvLEZyb206IGN0eC5mcm9tCn0=
+        body: base64://ZnVuY3Rpb24oY3R4KSB7ClRvOiBjdHguUmVjaXBpZW50LApCb2R5OiBjdHguQm9keSwKfQ==
         headers:
           Content-Type: application/x-www-form-urlencoded
         auth:

courier/http_channel.go

@@ -61,12 +61,12 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 
 	builder, err := request.NewBuilder(ctx, c.requestConfig, c.d)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	tmpl, err := newTemplate(c.d, msg)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	td := httpDataModel{
@@ -80,12 +80,12 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 
 	req, err := builder.BuildRequest(ctx, td)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	res, err := c.d.HTTPClient(ctx).Do(req)
 	if err != nil {
-		return err
+		return errors.WithStack(err)
 	}
 
 	if res.StatusCode >= 200 && res.StatusCode < 300 {
@@ -109,7 +109,7 @@ func (c *httpChannel) Dispatch(ctx context.Context, msg Message) (err error) {
 		WithField("message_subject", msg.Subject).
 		WithError(err).
 		Error("sending mail via HTTP failed.")
-	return err
+	return errors.WithStack(err)
 }
 
 func newTemplate(d template.Dependencies, msg Message) (Template, error) {

courier/sms.go

@@ -29,7 +29,7 @@ func (c *courier) QueueSMS(ctx context.Context, t SMSTemplate) (uuid.UUID, error
 	message := &Message{
 		Status:       MessageStatusQueued,
 		Type:         MessageTypeSMS,
-		Channel:      "phone",
+		Channel:      "sms",
 		Recipient:    recipient,
 		TemplateType: t.TemplateType(),
 		TemplateData: templateData,

courier/sms_test.go

@@ -80,7 +80,7 @@ func TestQueueSMS(t *testing.T) {
 	conf, reg := internal.NewFastRegistryWithMocks(t)
 	conf.MustSet(ctx, config.ViperKeyCourierChannels, fmt.Sprintf(`[
 		{
-			"id": "phone",
+			"id": "sms",
 			"type": "http",
 			"request_config": %s
 		}
@@ -122,7 +122,7 @@ func TestDisallowedInternalNetwork(t *testing.T) {
 	conf, reg := internal.NewFastRegistryWithMocks(t)
 	conf.MustSet(ctx, config.ViperKeyCourierChannels, `[
 		{
-			"id": "phone",
+			"id": "sms",
 			"type": "http",
 			"request_config": {
 				"url": "http://127.0.0.1/",

embedx/config.schema.json

@@ -1999,7 +1999,7 @@
                 "title": "Channel id",
                 "description": "The channel id. Corresponds to the .via property of the identity schema for recovery, verification, etc. Currently only phone is supported.",
                 "maxLength": 32,
-                "enum": ["phone"]
+                "enum": ["sms"]
               },
               "type": {
                 "type": "string",

embedx/identity_extension.schema.json

@@ -60,7 +60,7 @@
               "properties": {
                 "via": {
                   "type": "string",
-                  "enum": ["email", "phone"]
+                  "enum": ["email", "sms"]
                 }
               }
             },

embedx/identity_meta.schema.json

@@ -10,9 +10,7 @@
       "properties": {
         "properties": {
           "type": "object",
-          "required": [
-            "traits"
-          ],
+          "required": ["traits"],
           "properties": {
             "traits": {
               "type": "object",
@@ -27,6 +25,18 @@
                   "patternProperties": {
                     ".*": {
                       "type": "object",
+                      "properties": {
+                        "format": {
+                          "enum": [
+                            "email",
+                            "tel",
+                            "date",
+                            "time",
+                            "date-time",
+                            "noformat"
+                          ]
+                        }
+                      },
                       "allOf": [
                         {
                           "$ref": "ory://identity-extension"
@@ -40,9 +50,7 @@
           }
         }
       },
-      "required": [
-        "properties"
-      ]
+      "required": ["properties"]
     }
   ]
 }

identity/extension_verification.go

@@ -9,10 +9,18 @@ import (
 	"sync"
 	"time"
 
+	"golang.org/x/exp/maps"
+
 	"github.com/ory/jsonschema/v3"
 	"github.com/ory/kratos/schema"
 )
 
+func init() {
+	jsonschema.Formats["noformat"] = func(v interface{}) bool {
+		return true
+	}
+}
+
 type SchemaExtensionVerification struct {
 	lifespan time.Duration
 	l        sync.Mutex
@@ -24,40 +32,58 @@ func NewSchemaExtensionVerification(i *Identity, lifespan time.Duration) *Schema
 	return &SchemaExtensionVerification{i: i, lifespan: lifespan}
 }
 
+const (
+	ChannelTypeEmail = "email"
+	ChannelTypeSMS   = "sms"
+	ChannelTypePhone = "phone"
+)
+
 func (r *SchemaExtensionVerification) Run(ctx jsonschema.ValidationContext, s schema.ExtensionConfig, value interface{}) error {
 	r.l.Lock()
 	defer r.l.Unlock()
 
-	switch s.Verification.Via {
-	case AddressTypeEmail:
-		if !jsonschema.Formats["email"](value) {
-			return ctx.Error("format", "%q is not valid %q", value, "email")
-		}
-
-		address := NewVerifiableEmailAddress(
-			strings.ToLower(strings.TrimSpace(
-				fmt.Sprintf("%s", value))), r.i.ID)
-
-		r.appendAddress(address)
+	if s.Verification.Via == "" {
+		return nil
+	}
 
+	format, ok := s.RawSchema["format"]
+	if !ok {
+		format = ""
+	}
+	formatString, ok := format.(string)
+	if !ok {
 		return nil
+	}
 
-	case AddressTypePhone:
-		if !jsonschema.Formats["tel"](value) {
-			return ctx.Error("format", "%q is not valid %q", value, "phone")
+	if formatString == "" {
+		switch s.Verification.Via {
+		case ChannelTypeEmail:
+			formatString = "email"
+			formatter, ok := jsonschema.Formats[formatString]
+			if !ok {
+				supportedKeys := maps.Keys(jsonschema.Formats)
+				return ctx.Error("format", "format %q is not supported. Supported formats are [%s]", formatString, strings.Join(supportedKeys, ", "))
+			}
+
+			if !formatter(value) {
+				return ctx.Error("format", "%q is not valid %q", value, formatString)
+			}
+		default:
+			return ctx.Error("format", "no format specified. A format is required if verification is enabled. If this was intentional, please set \"format\" to \"noformat\"")
 		}
+	}
 
-		address := NewVerifiablePhoneAddress(fmt.Sprintf("%s", value), r.i.ID)
-
-		r.appendAddress(address)
-
-		return nil
-
-	case "":
-		return nil
+	var normalized string
+	switch formatString {
+	case "email":
+		normalized = strings.ToLower(strings.TrimSpace(fmt.Sprintf("%s", value)))
+	default:
+		normalized = strings.TrimSpace(fmt.Sprintf("%s", value))
 	}
 
-	return ctx.Error("", "verification.via has unknown value %q", s.Verification.Via)
+	address := NewVerifiableAddress(normalized, r.i.ID, s.Verification.Via)
+	r.appendAddress(address)
+	return nil
 }
 
 func (r *SchemaExtensionVerification) Finish() error {