api: Add cipher id to the MAC state

TheThingsNetwork · Aug 28, 2024 · 62d74b5 · 62d74b5
1 parent ad8ea3b
commit 62d74b5
Show file tree

Hide file tree

Showing 11 changed files with 795 additions and 698 deletions.
diff --git a/api/ttn/lorawan/v3/api.md b/api/ttn/lorawan/v3/api.md
@@ -4362,6 +4362,7 @@ This is used internally by the Network Server.
 | `last_adr_change_f_cnt_up` | [`uint32`](#uint32) |  | Frame counter of uplink, which confirmed the last ADR parameter change. |
 | `recent_mac_command_identifiers` | [`MACCommandIdentifier`](#ttn.lorawan.v3.MACCommandIdentifier) | repeated | MAC command identifiers sent by the end device in the last received uplink. The Network Server may choose to store only certain types of MAC command identifiers in the underlying implementation. |
 | `pending_relay_downlink` | [`RelayForwardDownlinkReq`](#ttn.lorawan.v3.RelayForwardDownlinkReq) |  | Pending relay downlink contents. The pending downlink will be scheduled to the relay in either Rx1 or Rx2. The pending downlink will be cleared after the scheduling attempt. |
+| `cipher_id` | [`uint32`](#uint32) |  | Used cipher suite for the device. |
 
 #### Field Rules
 
@@ -4374,6 +4375,7 @@ This is used internally by the Network Server.
 | `rejected_adr_data_rate_indexes` | <p>`repeated.max_items`: `15`</p><p>`repeated.items.enum.defined_only`: `true`</p> |
 | `rejected_adr_tx_power_indexes` | <p>`repeated.max_items`: `15`</p><p>`repeated.items.uint32.lte`: `15`</p> |
 | `rejected_frequencies` | <p>`repeated.items.uint64.gte`: `100000`</p> |
+| `cipher_id` | <p>`uint32.lte`: `64`</p> |
 
 ### <a name="ttn.lorawan.v3.MACState.DataRateRange">Message `MACState.DataRateRange`</a>
 

diff --git a/api/ttn/lorawan/v3/api.swagger.json b/api/ttn/lorawan/v3/api.swagger.json
@@ -26088,6 +26088,11 @@
         "pending_relay_downlink": {
           "$ref": "#/definitions/v3RelayForwardDownlinkReq",
           "description": "Pending relay downlink contents.\nThe pending downlink will be scheduled to the relay in either Rx1 or Rx2.\nThe pending downlink will be cleared after the scheduling attempt."
+        },
+        "cipher_id": {
+          "type": "integer",
+          "format": "int64",
+          "description": "Used cipher suite for the device."
         }
       },
       "description": "MACState represents the state of MAC layer of the device.\nMACState is reset on each join for OTAA or ResetInd for ABP devices.\nThis is used internally by the Network Server."

diff --git a/api/ttn/lorawan/v3/end_device.proto b/api/ttn/lorawan/v3/end_device.proto
@@ -919,6 +919,9 @@ message MACState {
   // The pending downlink will be scheduled to the relay in either Rx1 or Rx2.
   // The pending downlink will be cleared after the scheduling attempt.
   RelayForwardDownlinkReq pending_relay_downlink = 24;
+
+  // Used cipher suite for the device.
+  uint32 cipher_id = 25 [(validate.rules).uint32.lte = 64];
 }
 
 // Power state of the device.

diff --git a/pkg/ttnpb/end_device.pb.go b/pkg/ttnpb/end_device.pb.go
diff --git a/pkg/ttnpb/end_device.pb.paths.fm.go b/pkg/ttnpb/end_device.pb.paths.fm.go
diff --git a/pkg/ttnpb/end_device.pb.setters.fm.go b/pkg/ttnpb/end_device.pb.setters.fm.go
diff --git a/pkg/ttnpb/end_device.pb.validate.go b/pkg/ttnpb/end_device.pb.validate.go
diff --git a/pkg/ttnpb/end_device_flags.pb.go b/pkg/ttnpb/end_device_flags.pb.go
diff --git a/pkg/ttnpb/end_device_json.pb.go b/pkg/ttnpb/end_device_json.pb.go
diff --git a/pkg/ttnpb/qrcodegenerator.pb.paths.fm.go b/pkg/ttnpb/qrcodegenerator.pb.paths.fm.go
diff --git a/sdk/js/generated/api.json b/sdk/js/generated/api.json
@@ -18943,6 +18943,26 @@
               "isoneof": false,
               "oneofdecl": "",
               "defaultValue": ""
+            },
+            {
+              "name": "cipher_id",
+              "description": "Used cipher suite for the device.",
+              "label": "",
+              "type": "uint32",
+              "longType": "uint32",
+              "fullType": "uint32",
+              "ismap": false,
+              "isoneof": false,
+              "oneofdecl": "",
+              "defaultValue": "",
+              "options": {
+                "validate.rules": [
+                  {
+                    "name": "uint32.lte",
+                    "value": 64
+                  }
+                ]
+              }
             }
           ]
         },