Skip to content

Commit 42e2abf

Browse files
fabik111andreagilardoni
fabik111
authored and
andreagilardoni
committed
update uid and signature names
1 parent 10e146f commit 42e2abf

File tree

6 files changed

+70
-57
lines changed

6 files changed

+70
-57
lines changed

‎extras/test/src/test_command_encode.cpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -407,11 +407,11 @@ SCENARIO("Test the encoding of command messages") {
407407
}
408408
}
409409

410-
WHEN("Encode a message with provisioning uniqueId ")
410+
WHEN("Encode a message with provisioning uniqueHardwareId ")
411411
{
412-
ProvisioningUniqueIdMessage command;
413-
command.c.id = CommandId::ProvisioningUniqueId;
414-
memset(command.params.uniqueId, 0xCA, 32);
412+
ProvisioningUniqueHardwareIdMessage command;
413+
command.c.id = CommandId::ProvisioningUniqueHardwareId;
414+
memset(command.params.uniqueHardwareId, 0xCA, 32);
415415
uint8_t buffer[512];
416416
size_t bytes_encoded = sizeof(buffer);
417417

@@ -438,11 +438,11 @@ SCENARIO("Test the encoding of command messages") {
438438
}
439439
}
440440

441-
WHEN("Encode a message with provisioning signature ")
441+
WHEN("Encode a message with provisioning jwt ")
442442
{
443-
ProvisioningSignatureMessage command;
444-
command.c.id = CommandId::ProvisioningSignature;
445-
memset(command.params.signature, 0xCA, 246);
443+
ProvisioningJWTMessage command;
444+
command.c.id = CommandId::ProvisioningJWT;
445+
memset(command.params.jwt, 0xCA, 246);
446446
uint8_t buffer[512];
447447
size_t bytes_encoded = sizeof(buffer);
448448

‎src/cbor/CBOR.cpp‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -46,10 +46,10 @@ CommandId toCommandId(CBORCommandTag tag) {
4646
return CommandId::ProvisioningStatus;
4747
case CBORCommandTag::CBORProvisioningListWifiNetworks:
4848
return CommandId::ProvisioningListWifiNetworks;
49-
case CBORCommandTag::CBORProvisioningUniqueId:
50-
return CommandId::ProvisioningUniqueId;
51-
case CBORCommandTag::CBORProvisioningSignature:
52-
return CommandId::ProvisioningSignature;
49+
case CBORCommandTag::CBORProvisioningUniqueHardwareId:
50+
return CommandId::ProvisioningUniqueHardwareId;
51+
case CBORCommandTag::CBORProvisioningJWT:
52+
return CommandId::ProvisioningJWT;
5353
case CBORCommandTag::CBORProvisioningTimestamp:
5454
return CommandId::ProvisioningTimestamp;
5555
case CBORCommandTag::CBORProvisioningCommands:
@@ -101,10 +101,10 @@ CBORCommandTag toCBORCommandTag(CommandId id) {
101101
return CBORCommandTag::CBORProvisioningStatus;
102102
case CommandId::ProvisioningListWifiNetworks:
103103
return CBORCommandTag::CBORProvisioningListWifiNetworks;
104-
case CommandId::ProvisioningUniqueId:
105-
return CBORCommandTag::CBORProvisioningUniqueId;
106-
case CommandId::ProvisioningSignature:
107-
return CBORCommandTag::CBORProvisioningSignature;
104+
case CommandId::ProvisioningUniqueHardwareId:
105+
return CBORCommandTag::CBORProvisioningUniqueHardwareId;
106+
case CommandId::ProvisioningJWT:
107+
return CBORCommandTag::CBORProvisioningJWT;
108108
case CommandId::ProvisioningTimestamp:
109109
return CBORCommandTag::CBORProvisioningTimestamp;
110110
case CommandId::ProvisioningCommands:

‎src/cbor/CBOR.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,8 @@ enum CBORCommandTag: uint64_t {
3838
// Provisioning Commands
3939
CBORProvisioningStatus = 0x012000,
4040
CBORProvisioningListWifiNetworks = 0x012001,
41-
CBORProvisioningUniqueId = 0x012010,
42-
CBORProvisioningSignature = 0x012011,
41+
CBORProvisioningUniqueHardwareId = 0x012010,
42+
CBORProvisioningJWT = 0x012011,
4343
CBORProvisioningTimestamp = 0x012002,
4444
CBORProvisioningCommands = 0x012003,
4545
CBORProvisioningWifiConfig = 0x012004,

‎src/cbor/MessageEncoder.cpp‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ CBORMessageEncoder::EncoderState CBORMessageEncoder::handle_EncodeArray(CborEnco
104104
array_size = 2 * msg->params.numDiscoveredWiFiNetworks;
105105
break;
106106
}
107-
case CommandId::ProvisioningUniqueId:
107+
case CommandId::ProvisioningUniqueHardwareId:
108108
array_size = 1;
109109
break;
110-
case CommandId::ProvisioningSignature:
110+
case CommandId::ProvisioningJWT:
111111
array_size = 1;
112112
break;
113113
default:
@@ -149,11 +149,11 @@ CBORMessageEncoder::EncoderState CBORMessageEncoder::handle_EncodeParam(CborEnco
149149
case CommandId::ProvisioningListWifiNetworks:
150150
error = CBORMessageEncoder::encodeProvisioningListWifiNetworks(array_encoder, message);
151151
break;
152-
case CommandId::ProvisioningUniqueId:
153-
error = CBORMessageEncoder::encodeProvisioningUniqueId(array_encoder, message);
152+
case CommandId::ProvisioningUniqueHardwareId:
153+
error = CBORMessageEncoder::encodeProvisioningUniqueHardwareId(array_encoder, message);
154154
break;
155-
case CommandId::ProvisioningSignature:
156-
error = CBORMessageEncoder::encodeProvisioningSignature(array_encoder, message);
155+
case CommandId::ProvisioningJWT:
156+
error = CBORMessageEncoder::encodeProvisioningJWT(array_encoder, message);
157157
break;
158158
default:
159159
return EncoderState::MessageNotSupported;
@@ -219,16 +219,16 @@ CborError CBORMessageEncoder::encodeProvisioningListWifiNetworks(CborEncoder * a
219219
return CborNoError;
220220
}
221221

222-
CborError CBORMessageEncoder::encodeProvisioningUniqueId(CborEncoder * array_encoder, Message * message)
222+
CborError CBORMessageEncoder::encodeProvisioningUniqueHardwareId(CborEncoder * array_encoder, Message * message)
223223
{
224-
ProvisioningUniqueIdMessage * provisioningUniqueId = (ProvisioningUniqueIdMessage *) message;
225-
CHECK_CBOR(cbor_encode_byte_string(array_encoder, (uint8_t *) provisioningUniqueId->params.uniqueId, UID_SIZE));
224+
ProvisioningUniqueHardwareIdMessage * provisioningUniqueHardwareId = (ProvisioningUniqueHardwareIdMessage *) message;
225+
CHECK_CBOR(cbor_encode_byte_string(array_encoder, (uint8_t *) provisioningUniqueHardwareId->params.uniqueHardwareId, UHWID_SIZE));
226226
return CborNoError;
227227
}
228228

229-
CborError CBORMessageEncoder::encodeProvisioningSignature(CborEncoder * array_encoder, Message * message)
229+
CborError CBORMessageEncoder::encodeProvisioningJWT(CborEncoder * array_encoder, Message * message)
230230
{
231-
ProvisioningSignatureMessage * provisioningSignature = (ProvisioningSignatureMessage *) message;
232-
CHECK_CBOR(cbor_encode_byte_string(array_encoder, (uint8_t *) provisioningSignature->params.signature, SIGNATURE_SIZE));
231+
ProvisioningJWTMessage * provisioningJWT = (ProvisioningJWTMessage *) message;
232+
CHECK_CBOR(cbor_encode_byte_string(array_encoder, (uint8_t *) provisioningJWT->params.jwt, PROVISIONING_JWT_SIZE));
233233
return CborNoError;
234234
}

‎src/cbor/MessageEncoder.h‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,8 +64,8 @@ class CBORMessageEncoder: public Encoder
6464
//Provisioning specific encoders
6565
CborError encodeProvisioningStatus(CborEncoder * array_encoder, Message * message);
6666
CborError encodeProvisioningListWifiNetworks(CborEncoder * array_encoder, Message * message);
67-
CborError encodeProvisioningUniqueId(CborEncoder * array_encoder, Message * message);
68-
CborError encodeProvisioningSignature(CborEncoder * array_encoder, Message * message);
67+
CborError encodeProvisioningUniqueHardwareId(CborEncoder * array_encoder, Message * message);
68+
CborError encodeProvisioningJWT(CborEncoder * array_encoder, Message * message);
6969
};
7070

7171
#endif /* ARDUINO_CBOR_MESSAGE_ENCODER_H_ */

‎src/message/Commands.h‎

Lines changed: 38 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,21 @@
2626
#define URL_SIZE 256
2727
#define ID_SIZE 16
2828
#define MAX_LIB_VERSION_SIZE 10
29-
#define UID_SIZE 32
30-
#define SIGNATURE_SIZE 246
29+
#define UHWID_SIZE 32
30+
#define PROVISIONING_JWT_SIZE 246
31+
#define WIFI_SSID_SIZE 33 // Max length of ssid is 32 + \0
32+
#define WIFI_PWD_SIZE 64 // Max length of password is 63 + \0
33+
#define LORA_APPEUI_SIZE 17 // appeui is 8 octets * 2 (hex format) + \0
34+
#define LORA_APPKEY_SIZE 33 // appeui is 16 octets * 2 (hex format) + \0
35+
#define LORA_CHANNEL_MASK_SIZE 13
36+
#define LORA_DEVICE_CLASS_SIZE 2 // 1 char + \0
37+
#define PIN_SIZE 9 // 8 digits + \0
38+
#define APN_SIZE 101 // Max length of apn is 100 + \0
39+
#define LOGIN_SIZE 65 // Max length of login is 64 + \0
40+
#define PASS_SIZE 65 // Max length of password is 64 + \0
41+
#define BAND_SIZE 4
42+
#define MAX_WIFI_NETWORKS 20
43+
#define MAX_IP_SIZE 16
3144

3245
/******************************************************************************
3346
TYPEDEF
@@ -67,8 +80,8 @@ enum CommandId: uint32_t {
6780
/* Provisioning commands*/
6881
ProvisioningStatus,
6982
ProvisioningListWifiNetworks,
70-
ProvisioningUniqueId,
71-
ProvisioningSignature,
83+
ProvisioningUniqueHardwareId,
84+
ProvisioningJWT,
7285
ProvisioningTimestamp,
7386
ProvisioningCommands,
7487
ProvisioningWifiConfig,
@@ -180,22 +193,22 @@ struct WiFiNetwork {
180193
struct ProvisioningListWifiNetworksMessage {
181194
Command c;
182195
struct {
183-
WiFiNetwork discoveredWifiNetworks[20];
196+
WiFiNetwork discoveredWifiNetworks[MAX_WIFI_NETWORKS];
184197
uint8_t numDiscoveredWiFiNetworks = 0;
185198
} params;
186199
};
187200

188-
struct ProvisioningUniqueIdMessage {
201+
struct ProvisioningUniqueHardwareIdMessage {
189202
Command c;
190203
struct {
191-
char uniqueId[32]; //The payload is an array of char with a maximum length of 32, not null terminated. It's not a string.
204+
char uniqueHardwareId[UHWID_SIZE]; //The payload is an array of char with a maximum length of 32, not null terminated. It's not a string.
192205
} params;
193206
};
194207

195-
struct ProvisioningSignatureMessage {
208+
struct ProvisioningJWTMessage {
196209
Command c;
197210
struct {
198-
char signature[246]; //The payload is an array of char with a maximum length of 246, not null terminated. It's not a string.
211+
char jwt[PROVISIONING_JWT_SIZE]; //The payload is an array of char with a maximum length of 246, not null terminated. It's not a string.
199212
} params;
200213
};
201214

@@ -216,30 +229,30 @@ struct ProvisioningCommandsMessage {
216229
struct ProvisioningWifiConfigMessage {
217230
Command c;
218231
struct {
219-
char ssid[33]; // Max length of ssid is 32 + \0
220-
char pwd[64]; // Max length of password is 63 + \0
232+
char ssid[WIFI_SSID_SIZE];
233+
char pwd[WIFI_PWD_SIZE];
221234
} params;
222235
};
223236

224237
struct ProvisioningLoRaConfigMessage {
225238
Command c;
226239
struct {
227-
char appeui[17]; // appeui is 8 octets * 2 (hex format) + \0
228-
char appkey[33]; // appeui is 16 octets * 2 (hex format) + \0
240+
char appeui[LORA_APPEUI_SIZE];
241+
char appkey[LORA_APPKEY_SIZE];
229242
uint8_t band;
230-
char channelMask[13];
231-
char deviceClass[2];
243+
char channelMask[LORA_CHANNEL_MASK_SIZE];
244+
char deviceClass[LORA_DEVICE_CLASS_SIZE];
232245
} params;
233246
};
234247

235248
struct ProvisioningCATM1ConfigMessage {
236249
Command c;
237250
struct {
238-
char pin[9];
239-
char apn[101]; // Max length of apn is 100 + \0
240-
char login[65];
241-
char pass[65];
242-
uint32_t band[4];
251+
char pin[PIN_SIZE];
252+
char apn[APN_SIZE];
253+
char login[LOGIN_SIZE];
254+
char pass[PASS_SIZE];
255+
uint32_t band[BAND_SIZE];
243256
} params;
244257
};
245258

@@ -249,7 +262,7 @@ struct ProvisioningIPStruct{
249262
IPV6
250263
};
251264
IPType type;
252-
uint8_t ip[16];
265+
uint8_t ip[MAX_IP_SIZE];
253266
};
254267

255268
struct ProvisioningEthernetConfigMessage {
@@ -268,10 +281,10 @@ struct ProvisioningEthernetConfigMessage {
268281
struct ProvisioningCellularConfigMessage {
269282
Command c;
270283
struct {
271-
char pin[9];
272-
char apn[101]; // Max length of apn is 100 + \0
273-
char login[65];
274-
char pass[65];
284+
char pin[PIN_SIZE];
285+
char apn[APN_SIZE];
286+
char login[LOGIN_SIZE];
287+
char pass[PASS_SIZE];
275288
} params;
276289
};
277290

0 commit comments

Comments
 (0)