1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
33
34
35
36
37
38
39
40
41
42
43
44
47
48
49
54
55
56
57
58
59
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
113
114
118
119
123
124
128
129
133
134
138
139
143
144
145
146
150
151
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
194
195
196
197
198
199
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
363
364
365
366
367
368
369
373
374
375
376
377
378
379
380
381
382
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
453
454
455
456
457
458
459
460
461
462
472
473
482
483
488
489
490
491
492
493
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
522
523
524
525
526
527
528
529
533
534
535
536
537
544
545
546
547
548
549
550
551
552
553
554
555
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
578
579
580
581
582
583
584
585
586
587
588
589
590
591
601
602
603
604
605
606
607
608
609
610
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
673
674
675
676
677
/* ... */
/* ... */
#include "key_manager.hpp"
#include "crypto/hkdf_sha256.hpp"
#include "crypto/storage.hpp"
#include "instance/instance.hpp"
namespace ot {
RegisterLogModule("KeyManager");
const uint8_t KeyManager::kThreadString[] = {
'T', 'h', 'r', 'e', 'a', 'd',
}{...};
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
const uint8_t KeyManager::kHkdfExtractSaltString[] = {'T', 'h', 'r', 'e', 'a', 'd', 'S', 'e', 'q', 'u', 'e', 'n',
'c', 'e', 'M', 'a', 's', 't', 'e', 'r', 'K', 'e', 'y'}{...};
const uint8_t KeyManager::kTrelInfoString[] = {'T', 'h', 'r', 'e', 'a', 'd', 'O', 'v', 'e',
'r', 'I', 'n', 'f', 'r', 'a', 'K', 'e', 'y'}{...};/* ... */
#endif
void SecurityPolicy::SetToDefault(void)
{
Clear();
mRotationTime = kDefaultKeyRotationTime;
SetToDefaultFlags();
}{ ... }
void SecurityPolicy::SetToDefaultFlags(void)
{
mObtainNetworkKeyEnabled = true;
mNativeCommissioningEnabled = true;
mRoutersEnabled = true;
mExternalCommissioningEnabled = true;
mCommercialCommissioningEnabled = false;
mAutonomousEnrollmentEnabled = false;
mNetworkKeyProvisioningEnabled = false;
mTobleLinkEnabled = true;
mNonCcmRoutersEnabled = false;
mVersionThresholdForRouting = 0;
}{ ... }
void SecurityPolicy::SetFlags(const uint8_t *aFlags, uint8_t aFlagsLength)
{
OT_ASSERT(aFlagsLength > 0);
SetToDefaultFlags();
mObtainNetworkKeyEnabled = aFlags[0] & kObtainNetworkKeyMask;
mNativeCommissioningEnabled = aFlags[0] & kNativeCommissioningMask;
mRoutersEnabled = aFlags[0] & kRoutersMask;
mExternalCommissioningEnabled = aFlags[0] & kExternalCommissioningMask;
mCommercialCommissioningEnabled = (aFlags[0] & kCommercialCommissioningMask) == 0;
mAutonomousEnrollmentEnabled = (aFlags[0] & kAutonomousEnrollmentMask) == 0;
mNetworkKeyProvisioningEnabled = (aFlags[0] & kNetworkKeyProvisioningMask) == 0;
VerifyOrExit(aFlagsLength > sizeof(aFlags[0]));
mTobleLinkEnabled = aFlags[1] & kTobleLinkMask;
mNonCcmRoutersEnabled = (aFlags[1] & kNonCcmRoutersMask) == 0;
mVersionThresholdForRouting = aFlags[1] & kVersionThresholdForRoutingMask;
exit:
return;
}{ ... }
void SecurityPolicy::GetFlags(uint8_t *aFlags, uint8_t aFlagsLength) const
{
OT_ASSERT(aFlagsLength > 0);
memset(aFlags, 0, aFlagsLength);
if (mObtainNetworkKeyEnabled)
{
aFlags[0] |= kObtainNetworkKeyMask;
}{...}
if (mNativeCommissioningEnabled)
{
aFlags[0] |= kNativeCommissioningMask;
}{...}
if (mRoutersEnabled)
{
aFlags[0] |= kRoutersMask;
}{...}
if (mExternalCommissioningEnabled)
{
aFlags[0] |= kExternalCommissioningMask;
}{...}
if (!mCommercialCommissioningEnabled)
{
aFlags[0] |= kCommercialCommissioningMask;
}{...}
if (!mAutonomousEnrollmentEnabled)
{
aFlags[0] |= kAutonomousEnrollmentMask;
}{...}
if (!mNetworkKeyProvisioningEnabled)
{
aFlags[0] |= kNetworkKeyProvisioningMask;
}{...}
VerifyOrExit(aFlagsLength > sizeof(aFlags[0]));
if (mTobleLinkEnabled)
{
aFlags[1] |= kTobleLinkMask;
}{...}
if (!mNonCcmRoutersEnabled)
{
aFlags[1] |= kNonCcmRoutersMask;
}{...}
aFlags[1] |= kReservedMask;
aFlags[1] |= mVersionThresholdForRouting;
exit:
return;
}{...}
KeyManager::KeyManager(Instance &aInstance)
: InstanceLocator(aInstance)
, mKeySequence(0)
, mMleFrameCounter(0)
, mStoredMacFrameCounter(0)
, mStoredMleFrameCounter(0)
, mHoursSinceKeyRotation(0)
, mKeySwitchGuardTime(kDefaultKeySwitchGuardTime)
, mKeySwitchGuardTimer(0)
, mKeyRotationTimer(aInstance)
, mKekFrameCounter(0)
, mIsPskcSet(false)
{
otPlatCryptoInit();
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
{
NetworkKey networkKey;
mNetworkKeyRef = Crypto::Storage::kInvalidKeyRef;
mPskcRef = Crypto::Storage::kInvalidKeyRef;
IgnoreError(networkKey.GenerateRandom());
StoreNetworkKey(networkKey, false);
}/* ... */
{...}#else
IgnoreError(mNetworkKey.GenerateRandom());
mPskc.Clear();/* ... */
#endif
mMacFrameCounters.Reset();
}{ ... }
void KeyManager::Start(void)
{
mKeySwitchGuardTimer = 0;
ResetKeyRotationTimer();
}{ ... }
void KeyManager::Stop(void) { mKeyRotationTimer.Stop(); }
void KeyManager::SetPskc(const Pskc &aPskc)
{
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
if (Crypto::Storage::IsKeyRefValid(mPskcRef))
{
Pskc pskc;
GetPskc(pskc);
VerifyOrExit(aPskc != pskc, Get<Notifier>().SignalIfFirst(kEventPskcChanged));
}{...}
StorePskc(aPskc);
Get<Notifier>().Signal(kEventPskcChanged);/* ... */
#else
SuccessOrExit(Get<Notifier>().Update(mPskc, aPskc, kEventPskcChanged));
#endif
exit:
mIsPskcSet = true;
}{ ... }
void KeyManager::ResetFrameCounters(void)
{
Router *parent;
parent = &Get<Mle::MleRouter>().GetParent();
parent->SetKeySequence(0);
parent->GetLinkFrameCounters().Reset();
parent->SetLinkAckFrameCounter(0);
parent->SetMleFrameCounter(0);
#if OPENTHREAD_FTD
for (Router &router : Get<RouterTable>())
{
router.SetKeySequence(0);
router.GetLinkFrameCounters().Reset();
router.SetLinkAckFrameCounter(0);
router.SetMleFrameCounter(0);
}{...}
for (Child &child : Get<ChildTable>().Iterate(Child::kInStateAnyExceptInvalid))
{
child.SetKeySequence(0);
child.GetLinkFrameCounters().Reset();
child.SetLinkAckFrameCounter(0);
child.SetMleFrameCounter(0);
}{...}
#endif/* ... */
}{ ... }
void KeyManager::SetNetworkKey(const NetworkKey &aNetworkKey)
{
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
if (Crypto::Storage::IsKeyRefValid(mNetworkKeyRef))
{
NetworkKey networkKey;
GetNetworkKey(networkKey);
VerifyOrExit(networkKey != aNetworkKey, Get<Notifier>().SignalIfFirst(kEventNetworkKeyChanged));
}{...}
StoreNetworkKey(aNetworkKey, true);
Get<Notifier>().Signal(kEventNetworkKeyChanged);/* ... */
#else
SuccessOrExit(Get<Notifier>().Update(mNetworkKey, aNetworkKey, kEventNetworkKeyChanged));
#endif
Get<Notifier>().Signal(kEventThreadKeySeqCounterChanged);
mKeySequence = 0;
UpdateKeyMaterial();
ResetFrameCounters();
exit:
return;
}{ ... }
void KeyManager::ComputeKeys(uint32_t aKeySequence, HashKeys &aHashKeys) const
{
Crypto::HmacSha256 hmac;
uint8_t keySequenceBytes[sizeof(uint32_t)];
Crypto::Key cryptoKey;
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
cryptoKey.SetAsKeyRef(mNetworkKeyRef);
#else
cryptoKey.Set(mNetworkKey.m8, NetworkKey::kSize);
#endif
hmac.Start(cryptoKey);
BigEndian::WriteUint32(aKeySequence, keySequenceBytes);
hmac.Update(keySequenceBytes);
hmac.Update(kThreadString);
hmac.Finish(aHashKeys.mHash);
}{...}
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
void KeyManager::ComputeTrelKey(uint32_t aKeySequence, Mac::Key &aKey) const
{
Crypto::HkdfSha256 hkdf;
uint8_t salt[sizeof(uint32_t) + sizeof(kHkdfExtractSaltString)];
Crypto::Key cryptoKey;
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
cryptoKey.SetAsKeyRef(mNetworkKeyRef);
#else
cryptoKey.Set(mNetworkKey.m8, NetworkKey::kSize);
#endif
BigEndian::WriteUint32(aKeySequence, salt);
memcpy(salt + sizeof(uint32_t), kHkdfExtractSaltString, sizeof(kHkdfExtractSaltString));
hkdf.Extract(salt, sizeof(salt), cryptoKey);
hkdf.Expand(kTrelInfoString, sizeof(kTrelInfoString), aKey.m8, Mac::Key::kSize);
}{...}
/* ... */#endif
void KeyManager::UpdateKeyMaterial(void)
{
HashKeys hashKeys;
ComputeKeys(mKeySequence, hashKeys);
mMleKey.SetFrom(hashKeys.GetMleKey());
#if OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
{
Mac::KeyMaterial curKey;
Mac::KeyMaterial prevKey;
Mac::KeyMaterial nextKey;
curKey.SetFrom(hashKeys.GetMacKey(), kExportableMacKeys);
ComputeKeys(mKeySequence - 1, hashKeys);
prevKey.SetFrom(hashKeys.GetMacKey(), kExportableMacKeys);
ComputeKeys(mKeySequence + 1, hashKeys);
nextKey.SetFrom(hashKeys.GetMacKey(), kExportableMacKeys);
Get<Mac::SubMac>().SetMacKey(Mac::Frame::kKeyIdMode1, (mKeySequence & 0x7f) + 1, prevKey, curKey, nextKey);
}/* ... */
{...}#endif
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
{
Mac::Key key;
ComputeTrelKey(mKeySequence, key);
mTrelKey.SetFrom(key);
}/* ... */
{...}#endif
}{ ... }
void KeyManager::SetCurrentKeySequence(uint32_t aKeySequence, KeySeqUpdateFlags aFlags)
{
VerifyOrExit(aKeySequence != mKeySequence, Get<Notifier>().SignalIfFirst(kEventThreadKeySeqCounterChanged));
if (aFlags & kApplySwitchGuard)
{
VerifyOrExit(mKeySwitchGuardTimer == 0);
}{...}
mKeySequence = aKeySequence;
UpdateKeyMaterial();
SetAllMacFrameCounters(0, false);
mMleFrameCounter = 0;
ResetKeyRotationTimer();
if (aFlags & kResetGuardTimer)
{
mKeySwitchGuardTimer = mKeySwitchGuardTime;
}{...}
Get<Notifier>().Signal(kEventThreadKeySeqCounterChanged);
exit:
return;
}{ ... }
const Mle::KeyMaterial &KeyManager::GetTemporaryMleKey(uint32_t aKeySequence)
{
HashKeys hashKeys;
ComputeKeys(aKeySequence, hashKeys);
mTemporaryMleKey.SetFrom(hashKeys.GetMleKey());
return mTemporaryMleKey;
}{ ... }
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
const Mle::KeyMaterial &KeyManager::GetTemporaryMacKey(uint32_t aKeySequence)
{
HashKeys hashKeys;
ComputeKeys(aKeySequence, hashKeys);
mTemporaryMacKey.SetFrom(hashKeys.GetMacKey());
return mTemporaryMacKey;
}{...}
/* ... */#endif
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
const Mac::KeyMaterial &KeyManager::GetTemporaryTrelMacKey(uint32_t aKeySequence)
{
Mac::Key key;
ComputeTrelKey(aKeySequence, key);
mTemporaryTrelKey.SetFrom(key);
return mTemporaryTrelKey;
}{...}
/* ... */#endif
void KeyManager::SetAllMacFrameCounters(uint32_t aFrameCounter, bool aSetIfLarger)
{
mMacFrameCounters.SetAll(aFrameCounter);
#if OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
Get<Mac::SubMac>().SetFrameCounter(aFrameCounter, aSetIfLarger);
#else
OT_UNUSED_VARIABLE(aSetIfLarger);
#endif
}{ ... }
#if OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
void KeyManager::MacFrameCounterUsed(uint32_t aMacFrameCounter)
{
VerifyOrExit(mMacFrameCounters.Get154() <= aMacFrameCounter);
mMacFrameCounters.Set154(aMacFrameCounter + 1);
if (mMacFrameCounters.Get154() >= mStoredMacFrameCounter)
{
IgnoreError(Get<Mle::MleRouter>().Store());
}{...}
exit:
return;
}{ ... }
/* ... */#else
void KeyManager::MacFrameCounterUsed(uint32_t) {}
#endif
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
void KeyManager::IncrementTrelMacFrameCounter(void)
{
mMacFrameCounters.IncrementTrel();
if (mMacFrameCounters.GetTrel() >= mStoredMacFrameCounter)
{
IgnoreError(Get<Mle::MleRouter>().Store());
}{...}
}{...}
/* ... */#endif
void KeyManager::IncrementMleFrameCounter(void)
{
mMleFrameCounter++;
if (mMleFrameCounter >= mStoredMleFrameCounter)
{
IgnoreError(Get<Mle::MleRouter>().Store());
}{...}
}{ ... }
void KeyManager::SetKek(const Kek &aKek)
{
mKek.SetFrom(aKek, true);
mKekFrameCounter = 0;
}{ ... }
void KeyManager::SetSecurityPolicy(const SecurityPolicy &aSecurityPolicy)
{
SecurityPolicy newPolicy = aSecurityPolicy;
if (newPolicy.mRotationTime < SecurityPolicy::kMinKeyRotationTime)
{
newPolicy.mRotationTime = SecurityPolicy::kMinKeyRotationTime;
LogNote("Key Rotation Time in SecurityPolicy is set to min allowed value of %u", newPolicy.mRotationTime);
}{...}
if (newPolicy.mRotationTime != mSecurityPolicy.mRotationTime)
{
uint32_t newGuardTime = newPolicy.mRotationTime;
newGuardTime *= kKeySwitchGuardTimePercentage;
newGuardTime /= 100;
mKeySwitchGuardTime = static_cast<uint16_t>(newGuardTime);
}{...}
IgnoreError(Get<Notifier>().Update(mSecurityPolicy, newPolicy, kEventSecurityPolicyChanged));
CheckForKeyRotation();
}{ ... }
void KeyManager::ResetKeyRotationTimer(void)
{
mHoursSinceKeyRotation = 0;
mKeyRotationTimer.Start(Time::kOneHourInMsec);
}{ ... }
void KeyManager::HandleKeyRotationTimer(void)
{
mKeyRotationTimer.Start(Time::kOneHourInMsec);
mHoursSinceKeyRotation++;
if (mKeySwitchGuardTimer > 0)
{
mKeySwitchGuardTimer--;
}{...}
CheckForKeyRotation();
}{ ... }
void KeyManager::CheckForKeyRotation(void)
{
if (mHoursSinceKeyRotation >= mSecurityPolicy.mRotationTime)
{
SetCurrentKeySequence(mKeySequence + 1, kForceUpdate | kResetGuardTimer);
}{...}
}{ ... }
void KeyManager::GetNetworkKey(NetworkKey &aNetworkKey) const
{
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
if (Crypto::Storage::HasKey(mNetworkKeyRef))
{
size_t keyLen;
SuccessOrAssert(Crypto::Storage::ExportKey(mNetworkKeyRef, aNetworkKey.m8, NetworkKey::kSize, keyLen));
OT_ASSERT(keyLen == NetworkKey::kSize);
}{...}
else
{
aNetworkKey.Clear();
}{...}
#else/* ... */
aNetworkKey = mNetworkKey;
#endif
}{...}
void KeyManager::GetPskc(Pskc &aPskc) const
{
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
if (Crypto::Storage::HasKey(mPskcRef))
{
size_t keyLen;
SuccessOrAssert(Crypto::Storage::ExportKey(mPskcRef, aPskc.m8, Pskc::kSize, keyLen));
OT_ASSERT(keyLen == Pskc::kSize);
}{...}
else
{
aPskc.Clear();
}{...}
#else/* ... */
aPskc = mPskc;
#endif
}{...}
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
void KeyManager::StoreNetworkKey(const NetworkKey &aNetworkKey, bool aOverWriteExisting)
{
NetworkKeyRef keyRef;
keyRef = Crypto::Storage::kNetworkKeyRef;
if (!aOverWriteExisting)
{
if (Crypto::Storage::HasKey(keyRef))
{
ExitNow();
}{...}
}{...}
Crypto::Storage::DestroyKey(keyRef);
SuccessOrAssert(Crypto::Storage::ImportKey(keyRef, Crypto::Storage::kKeyTypeHmac,
Crypto::Storage::kKeyAlgorithmHmacSha256,
Crypto::Storage::kUsageSignHash | Crypto::Storage::kUsageExport,
Crypto::Storage::kTypePersistent, aNetworkKey.m8, NetworkKey::kSize));
exit:
if (mNetworkKeyRef != keyRef)
{
Crypto::Storage::DestroyKey(mNetworkKeyRef);
}{...}
mNetworkKeyRef = keyRef;
}{...}
void KeyManager::StorePskc(const Pskc &aPskc)
{
PskcRef keyRef = Crypto::Storage::kPskcRef;
Crypto::Storage::DestroyKey(keyRef);
SuccessOrAssert(Crypto::Storage::ImportKey(keyRef, Crypto::Storage::kKeyTypeRaw,
Crypto::Storage::kKeyAlgorithmVendor, Crypto::Storage::kUsageExport,
Crypto::Storage::kTypePersistent, aPskc.m8, Pskc::kSize));
if (mPskcRef != keyRef)
{
Crypto::Storage::DestroyKey(mPskcRef);
}{...}
mPskcRef = keyRef;
}{...}
void KeyManager::SetPskcRef(PskcRef aKeyRef)
{
VerifyOrExit(mPskcRef != aKeyRef, Get<Notifier>().SignalIfFirst(kEventPskcChanged));
Crypto::Storage::DestroyKey(mPskcRef);
mPskcRef = aKeyRef;
Get<Notifier>().Signal(kEventPskcChanged);
exit:
mIsPskcSet = true;
}{...}
void KeyManager::SetNetworkKeyRef(otNetworkKeyRef aKeyRef)
{
VerifyOrExit(mNetworkKeyRef != aKeyRef, Get<Notifier>().SignalIfFirst(kEventNetworkKeyChanged));
Crypto::Storage::DestroyKey(mNetworkKeyRef);
mNetworkKeyRef = aKeyRef;
Get<Notifier>().Signal(kEventNetworkKeyChanged);
Get<Notifier>().Signal(kEventThreadKeySeqCounterChanged);
mKeySequence = 0;
UpdateKeyMaterial();
ResetFrameCounters();
exit:
return;
}{...}
void KeyManager::DestroyTemporaryKeys(void)
{
mMleKey.Clear();
mKek.Clear();
Get<Mac::SubMac>().ClearMacKeys();
Get<Mac::Mac>().ClearMode2Key();
}{...}
void KeyManager::DestroyPersistentKeys(void) { Crypto::Storage::DestroyPersistentKeys(); }/* ... */
#endif
}{...}