Remove contact_info from validation process

api/buf.yaml

@@ -65,6 +65,7 @@ lint:
       - ttn/lorawan/v3/contact_info.proto
       - ttn/lorawan/v3/deviceclaimingserver.proto
       - ttn/lorawan/v3/devicerepository.proto
+      - ttn/lorawan/v3/email_validation.proto
       - ttn/lorawan/v3/end_device_services.proto
       - ttn/lorawan/v3/gateway_services.proto
       - ttn/lorawan/v3/gatewayserver.proto
@@ -88,6 +89,7 @@ lint:
       - ttn/lorawan/v3/contact_info.proto
       - ttn/lorawan/v3/deviceclaimingserver.proto
       - ttn/lorawan/v3/devicerepository.proto
+      - ttn/lorawan/v3/email_validation.proto
       - ttn/lorawan/v3/end_device_services.proto
       - ttn/lorawan/v3/events.proto
       - ttn/lorawan/v3/gateway_services.proto
@@ -112,6 +114,7 @@ lint:
       - ttn/lorawan/v3/contact_info.proto
       - ttn/lorawan/v3/deviceclaimingserver.proto
       - ttn/lorawan/v3/devicerepository.proto
+      - ttn/lorawan/v3/email_validation.proto
       - ttn/lorawan/v3/end_device_services.proto
       - ttn/lorawan/v3/events.proto
       - ttn/lorawan/v3/gateway_services.proto
@@ -138,6 +141,7 @@ lint:
       - ttn/lorawan/v3/contact_info.proto
       - ttn/lorawan/v3/deviceclaimingserver.proto
       - ttn/lorawan/v3/devicerepository.proto
+      - ttn/lorawan/v3/email_validation.proto
       - ttn/lorawan/v3/end_device_services.proto
       - ttn/lorawan/v3/events.proto
       - ttn/lorawan/v3/gateway_services.proto

api/ttn/lorawan/v3/api.md

@@ -228,6 +228,10 @@
   - [Service `DeviceRepository`](#ttn.lorawan.v3.DeviceRepository)
 - [File `ttn/lorawan/v3/email_messages.proto`](#ttn/lorawan/v3/email_messages.proto)
   - [Message `CreateClientEmailMessage`](#ttn.lorawan.v3.CreateClientEmailMessage)
+- [File `ttn/lorawan/v3/email_validation.proto`](#ttn/lorawan/v3/email_validation.proto)
+  - [Message `EmailValidation`](#ttn.lorawan.v3.EmailValidation)
+  - [Message `ValidateEmailRequest`](#ttn.lorawan.v3.ValidateEmailRequest)
+  - [Service `EmailValidationRegistry`](#ttn.lorawan.v3.EmailValidationRegistry)
 - [File `ttn/lorawan/v3/end_device.proto`](#ttn/lorawan/v3/end_device.proto)
   - [Message `ADRSettings`](#ttn.lorawan.v3.ADRSettings)
   - [Message `ADRSettings.DisabledMode`](#ttn.lorawan.v3.ADRSettings.DisabledMode)
@@ -3624,6 +3628,57 @@ CreateClientEmailMessage is used as a wrapper for handling the email regarding t
 | `create_client_request` | [`CreateClientRequest`](#ttn.lorawan.v3.CreateClientRequest) |  |  |
 | `api_key` | [`APIKey`](#ttn.lorawan.v3.APIKey) |  |  |
 
+## <a name="ttn/lorawan/v3/email_validation.proto">File `ttn/lorawan/v3/email_validation.proto`</a>
+
+### <a name="ttn.lorawan.v3.EmailValidation">Message `EmailValidation`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `id` | [`string`](#string) |  |  |
+| `token` | [`string`](#string) |  |  |
+| `address` | [`string`](#string) |  |  |
+| `created_at` | [`google.protobuf.Timestamp`](#google.protobuf.Timestamp) |  |  |
+| `expires_at` | [`google.protobuf.Timestamp`](#google.protobuf.Timestamp) |  |  |
+| `updated_at` | [`google.protobuf.Timestamp`](#google.protobuf.Timestamp) |  |  |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `id` | <p>`string.min_len`: `1`</p><p>`string.max_len`: `64`</p> |
+| `token` | <p>`string.min_len`: `1`</p><p>`string.max_len`: `64`</p> |
+| `address` | <p>`string.email`: `true`</p> |
+
+### <a name="ttn.lorawan.v3.ValidateEmailRequest">Message `ValidateEmailRequest`</a>
+
+| Field | Type | Label | Description |
+| ----- | ---- | ----- | ----------- |
+| `id` | [`string`](#string) |  |  |
+| `token` | [`string`](#string) |  |  |
+
+#### Field Rules
+
+| Field | Validations |
+| ----- | ----------- |
+| `id` | <p>`string.min_len`: `1`</p><p>`string.max_len`: `64`</p> |
+| `token` | <p>`string.min_len`: `1`</p><p>`string.max_len`: `64`</p> |
+
+### <a name="ttn.lorawan.v3.EmailValidationRegistry">Service `EmailValidationRegistry`</a>
+
+The EmailValidationRegistry service, exposed by the Identity Server, is used for validating an user's primary email.
+
+| Method Name | Request Type | Response Type | Description |
+| ----------- | ------------ | ------------- | ------------|
+| `RequestValidation` | [`UserIdentifiers`](#ttn.lorawan.v3.UserIdentifiers) | [`EmailValidation`](#ttn.lorawan.v3.EmailValidation) | Request validation for the non-validated contact info for the given entity. |
+| `Validate` | [`ValidateEmailRequest`](#ttn.lorawan.v3.ValidateEmailRequest) | [`.google.protobuf.Empty`](#google.protobuf.Empty) | Validate confirms a contact info validation. |
+
+#### HTTP bindings
+
+| Method Name | Method | Pattern | Body |
+| ----------- | ------ | ------- | ---- |
+| `RequestValidation` | `POST` | `/api/v3/email/validation` | `*` |
+| `Validate` | `PATCH` | `/api/v3/email/validation` | `*` |
+
 ## <a name="ttn/lorawan/v3/end_device.proto">File `ttn/lorawan/v3/end_device.proto`</a>
 
 ### <a name="ttn.lorawan.v3.ADRSettings">Message `ADRSettings`</a>

api/ttn/lorawan/v3/api.swagger.json

@@ -62,6 +62,9 @@
     {
       "name": "DeviceRepository"
     },
+    {
+      "name": "EmailValidationRegistry"
+    },
     {
       "name": "EndDeviceRegistry"
     },
@@ -6470,6 +6473,71 @@
         ]
       }
     },
+    "/email/validation": {
+      "post": {
+        "summary": "Request validation for the non-validated contact info for the given entity.",
+        "operationId": "EmailValidationRegistry_RequestValidation",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "$ref": "#/definitions/v3EmailValidation"
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/googlerpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/v3UserIdentifiers"
+            }
+          }
+        ],
+        "tags": [
+          "EmailValidationRegistry"
+        ]
+      },
+      "patch": {
+        "summary": "Validate confirms a contact info validation.",
+        "operationId": "EmailValidationRegistry_Validate",
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "schema": {
+              "type": "object",
+              "properties": {}
+            }
+          },
+          "default": {
+            "description": "An unexpected error response.",
+            "schema": {
+              "$ref": "#/definitions/googlerpcStatus"
+            }
+          }
+        },
+        "parameters": [
+          {
+            "name": "body",
+            "in": "body",
+            "required": true,
+            "schema": {
+              "$ref": "#/definitions/v3ValidateEmailRequest"
+            }
+          }
+        ],
+        "tags": [
+          "EmailValidationRegistry"
+        ]
+      }
+    },
     "/events": {
       "post": {
         "summary": "Stream live events, optionally with a tail of historical events (depending on server support and retention policy).\nEvents may arrive out-of-order.",
@@ -20094,6 +20162,32 @@
       "default": "DOWNLINK_PATH_CONSTRAINT_NONE",
       "description": " - DOWNLINK_PATH_CONSTRAINT_NONE: Indicates that the gateway can be selected for downlink without constraints by the Network Server.\n - DOWNLINK_PATH_CONSTRAINT_PREFER_OTHER: Indicates that the gateway can be selected for downlink only if no other or better gateway can be selected.\n - DOWNLINK_PATH_CONSTRAINT_NEVER: Indicates that this gateway will never be selected for downlink, even if that results in no available downlink path."
     },
+    "v3EmailValidation": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "token": {
+          "type": "string"
+        },
+        "address": {
+          "type": "string"
+        },
+        "created_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "expires_at": {
+          "type": "string",
+          "format": "date-time"
+        },
+        "updated_at": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    },
     "v3EncodeDownlinkResponse": {
       "type": "object",
       "properties": {
@@ -26225,6 +26319,17 @@
         }
       }
     },
+    "v3ValidateEmailRequest": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "token": {
+          "type": "string"
+        }
+      }
+    },
     "v3ZeroableFrequencyValue": {
       "type": "object",
       "properties": {

api/ttn/lorawan/v3/email_validation.proto

@@ -0,0 +1,69 @@
+// Copyright © 2023 The Things Network Foundation, The Things Industries B.V.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package ttn.lorawan.v3;
+
+import "google/api/annotations.proto";
+import "google/protobuf/empty.proto";
+import "google/protobuf/timestamp.proto";
+import "ttn/lorawan/v3/identifiers.proto";
+import "validate/validate.proto";
+
+option go_package = "go.thethings.network/lorawan-stack/v3/pkg/ttnpb";
+
+message EmailValidation {
+  string id = 1 [(validate.rules).string = {
+    max_len: 64,
+    min_len: 1
+  }];
+  string token = 2 [(validate.rules).string = {
+    max_len: 64,
+    min_len: 1
+  }];
+  string address = 3 [(validate.rules).string.email = true];
+  google.protobuf.Timestamp created_at = 4;
+  google.protobuf.Timestamp expires_at = 5;
+  google.protobuf.Timestamp updated_at = 6;
+}
+
+message ValidateEmailRequest {
+  string id = 1 [(validate.rules).string = {
+    max_len: 64,
+    min_len: 1
+  }];
+  string token = 2 [(validate.rules).string = {
+    max_len: 64,
+    min_len: 1
+  }];
+}
+
+// The EmailValidationRegistry service, exposed by the Identity Server, is used for validating an user's primary email.
+service EmailValidationRegistry {
+  // Request validation for the non-validated contact info for the given entity.
+  rpc RequestValidation(UserIdentifiers) returns (EmailValidation) {
+    option (google.api.http) = {
+      post: "/email/validation"
+      body: "*"
+    };
+  }
+  // Validate confirms a contact info validation.
+  rpc Validate(ValidateEmailRequest) returns (google.protobuf.Empty) {
+    option (google.api.http) = {
+      patch: "/email/validation"
+      body: "*"
+    };
+  }
+}

cmd/ttn-lw-cli/commands/contact_info.go

@@ -136,8 +136,6 @@ func updateContactInfo(entityID *ttnpb.EntityIdentifiers, updater func([]*ttnpb.
 var (
 	errContactInfoExists           = errors.DefineAlreadyExists("contact_info_exists", "contact info already exists")
 	errMatchingContactInfoNotFound = errors.DefineAlreadyExists("contact_info_not_found", "matching contact info not found")
-	errNoValidationReference       = errors.DefineInvalidArgument("no_validation_reference", "no validation reference set")
-	errNoValidationToken           = errors.DefineInvalidArgument("no_validation_token", "no validation token set")
 )
 
 func contactInfoCommands(entity string, getID func(cmd *cobra.Command, args []string) (*ttnpb.EntityIdentifiers, error)) *cobra.Command {
@@ -228,8 +226,9 @@ func contactInfoCommands(entity string, getID func(cmd *cobra.Command, args []st
 		},
 	}
 	requestValidation := &cobra.Command{
-		Use:   fmt.Sprintf("request-validation [%s-id]", entity),
-		Short: "Request validation for entity contact info",
+		Use:    fmt.Sprintf("request-validation [%s-id]", entity),
+		Short:  "Request validation for entity contact info (DEPRECATED. Use `user email-validation request` instead.",
+		Hidden: true,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			id, err := getID(cmd, args)
 			if err != nil {
@@ -247,9 +246,9 @@ func contactInfoCommands(entity string, getID func(cmd *cobra.Command, args []st
 		},
 	}
 	validate := &cobra.Command{
-		Use:   "validate [reference] [token]",
-		Short: "Validate contact info",
-		Long:  "Validate contact info by providing the reference and the validation token that you received",
+		Use:    "validate [reference] [token]",
+		Short:  "Validate contact info (DEPRECATED. Use `user email-validation validate` instead.",
+		Hidden: true,
 		RunE: func(cmd *cobra.Command, args []string) error {
 			reference, _ := cmd.Flags().GetString("reference")
 			token, _ := cmd.Flags().GetString("token")