se-identity.h File Reference

Secure Element identity and keys. More...

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Macros
#define	LORAWAN_DEVICE_EUI   00,00,00,00,00,00,00,00
#define	LORAWAN_JOIN_EUI   01,01,01,01,01,01,01,01
#define	LORAWAN_DEVICE_ADDRESS   00,00,00,00
#define	LORAWAN_APP_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C
#define	LORAWAN_NWK_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C
#define	LORAWAN_NWK_S_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C
#define	LORAWAN_APP_S_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C
#define	RAW_TO_INT8A(a, b, c, d, e, f, g, h, i, j, k, l, m, n, o, p)
#define	RAW8_TO_INT8A(a, b, c, d)
#define	RAW32_TO_INT8A(a, b, c, d, e, f, g, h)
#define	FORMAT_KEY(...)
#define	FORMAT8_KEY(...)
#define	FORMAT32_KEY(...)
#define	SESSION_KEYS_LIST
#define	SESSION_MC_KEYS_LIST
#define	SOFT_SE_KEY_LIST
#define	SOFT_SE_ID_LIST

Detailed Description

Secure Element identity and keys.

Copyright

Revised BSD License, see section LICENSE.

  ______                              _
 / _____)             _              | |
( (____  _____ ____ _| |_ _____  ____| |__
 \____ \| ___ |    (_   _) ___ |/ ___)  _ \
 _____) ) ____| | | || |_| ____( (___| | | |
(______/|_____)_|_|_| \__)_____)\____)_| |_|
(C)2020 Semtech
 
 ___ _____ _   ___ _  _____ ___  ___  ___ ___
/ __|_   _/_\ / __| |/ / __/ _ \| _ \/ __| __|
\__ \ | |/ _ \ (__| ' <| _| (_) |   / (__| _|
|___/ |_/_/ \_\___|_|\_\_| \___/|_|_\\___|___|
embedded.connectivity.solutions===============

Portions COPYRIGHT 2020 STMicroelectronics

Author

MCD Application Team

Definition in file se-identity.h.

Macro Definition Documentation

FORMAT32_KEY

#define FORMAT32_KEY

(

...

)

Value:

RAW32_TO_INT8A(__VA_ARGS__)

Definition at line 139 of file se-identity.h.

FORMAT8_KEY

#define FORMAT8_KEY

(

...

)

Value:

RAW8_TO_INT8A(__VA_ARGS__)

Definition at line 138 of file se-identity.h.

FORMAT_KEY

#define FORMAT_KEY

(

...

)

Value:

RAW_TO_INT8A(__VA_ARGS__)

Definition at line 137 of file se-identity.h.

LORAWAN_APP_KEY

#define LORAWAN_APP_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C

Application root key

Definition at line 108 of file se-identity.h.

LORAWAN_APP_S_KEY

#define LORAWAN_APP_S_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C

Application session key

Definition at line 123 of file se-identity.h.

LORAWAN_DEVICE_ADDRESS

#define LORAWAN_DEVICE_ADDRESS   00,00,00,00

Device address on the network (big endian) When set to 00,00,00,00 DevAddr is automatically set with a value provided by MCU platform

Definition at line 103 of file se-identity.h.

LORAWAN_DEVICE_EUI

#define LORAWAN_DEVICE_EUI   00,00,00,00,00,00,00,00

                             WARNING ***********************************

The secure-element implementation supports both 1.0.x and 1.1.x LoRaWAN versions of the specification. Thus it has been decided to use the 1.1.x keys and EUI name definitions. The below table shows the names equivalence between versions: +------------------—+----------------------—+ | 1.0.x | 1.1.x | +=====================+=========================+ | LORAWAN_DEVICE_EUI | LORAWAN_DEVICE_EUI | +------------------—+----------------------—+ | LORAWAN_APP_EUI | LORAWAN_JOIN_EUI | +------------------—+----------------------—+ | LORAWAN_GEN_APP_KEY | LORAWAN_APP_KEY | +------------------—+----------------------—+ | LORAWAN_APP_KEY | LORAWAN_NWK_KEY | +------------------—+----------------------—+ | LORAWAN_NWK_S_KEY | LORAWAN_F_NWK_S_INT_KEY | +------------------—+----------------------—+ | LORAWAN_NWK_S_KEY | LORAWAN_S_NWK_S_INT_KEY | +------------------—+----------------------—+ | LORAWAN_NWK_S_KEY | LORAWAN_NWK_S_ENC_KEY | +------------------—+----------------------—+ | LORAWAN_APP_S_KEY | LORAWAN_APP_S_KEY | +------------------—+----------------------—+

End-device IEEE EUI (big endian) When set to 00,00,00,00,00,00,00,00 DevEui is automatically set with a value provided by MCU platform

Definition at line 92 of file se-identity.h.

LORAWAN_JOIN_EUI

#define LORAWAN_JOIN_EUI   01,01,01,01,01,01,01,01

App/Join server IEEE EUI (big endian)

Definition at line 97 of file se-identity.h.

LORAWAN_NWK_KEY

#define LORAWAN_NWK_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C

Network root key

Definition at line 113 of file se-identity.h.

LORAWAN_NWK_S_KEY

#define LORAWAN_NWK_S_KEY   2B,7E,15,16,28,AE,D2,A6,AB,F7,15,88,09,CF,4F,3C

Forwarding Network session key

Definition at line 118 of file se-identity.h.

RAW32_TO_INT8A

#define RAW32_TO_INT8A	(		a,
			b,
			c,
			d,
			e,
			f,
			g,
			h )

Value:

{0x##a,0x##b,0x##c,0x##d,\
0x##e,0x##f,0x##g,0x##h}

Definition at line 134 of file se-identity.h.

RAW8_TO_INT8A

#define RAW8_TO_INT8A	(		a,
			b,
			c,
			d )

Value:

0x##a##b##c##d

Definition at line 133 of file se-identity.h.

RAW_TO_INT8A

#define RAW_TO_INT8A	(		a,
			b,
			c,
			d,
			e,
			f,
			g,
			h,
			i,
			j,
			k,
			l,
			m,
			n,
			o,
			p )

Value:

{0x##a,0x##b,0x##c,0x##d,\
0x##e,0x##f,0x##g,0x##h,\
0x##i,0x##j,0x##k,0x##l,\
0x##m,0x##n,0x##o,0x##p}

Format commissioning keys

Definition at line 128 of file se-identity.h.

SESSION_KEYS_LIST

#define SESSION_KEYS_LIST

Value:

{                                                                                                           \
    /*!                                                                                                     \
     * Network session key                                                                                  \
     */                                                                                                     \
    .KeyID    = NWK_S_KEY,                                                                                  \
    .KeyValue = FORMAT_KEY(LORAWAN_NWK_S_KEY),                                                              \
},                                                                                                          \
{                                                                                                           \
    /*!                                                                                                     \
     * Application session key                                                                              \
     */                                                                                                     \
    .KeyID    = APP_S_KEY,                                                                                  \
    .KeyValue = FORMAT_KEY(LORAWAN_APP_S_KEY),                                                              \
},                                                                                                          \
{                                                                                                           \
    /*!                                                                                                     \
     * Datablock MIC key                                                                                    \
     */                                                                                                     \
    .KeyID    = DATABLOCK_INT_KEY,                                                                          \
    .KeyValue = { 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, \
                  0x00 },                                                                                   \
},

Definition at line 203 of file se-identity.h.

SESSION_MC_KEYS_LIST

#define SESSION_MC_KEYS_LIST

Definition at line 249 of file se-identity.h.

SOFT_SE_ID_LIST

#define SOFT_SE_ID_LIST

Value:

.SeNvmDevJoinKey.DevEui = FORMAT32_KEY(LORAWAN_DEVICE_EUI),                                                     \
.SeNvmDevJoinKey.JoinEui = FORMAT32_KEY(LORAWAN_JOIN_EUI),                                                      \
.SeNvmDevJoinKey.DevAddrOTAA = FORMAT8_KEY(LORAWAN_DEVICE_ADDRESS),                                             \
.SeNvmDevJoinKey.DevAddrABP = FORMAT8_KEY(LORAWAN_DEVICE_ADDRESS)                                               \

Definition at line 358 of file se-identity.h.

SOFT_SE_KEY_LIST

#define SOFT_SE_KEY_LIST

Definition at line 324 of file se-identity.h.