Symbols ![]()
loading...
Files ![]()
loading (2/5)...
ot::KeyManager class
Defines Thread Key Manager.
Syntax
class KeyManager : public InstanceLocator,
private NonCopyable
{
public:
enum KeySeqUpdateFlag : uint8_t
{
kApplySwitchGuard = (1 << 0),
kForceUpdate = (0 << 0),
kResetGuardTimer = (1 << 1),
kGuardTimerUnchanged = (0 << 1),
};
typedef uint8_t KeySeqUpdateFlags;
explicit KeyManager(Instance &aInstance);
void Start(void);
void Stop(void);
void GetNetworkKey(NetworkKey &aNetworkKey) const;
void SetNetworkKey(const NetworkKey &aNetworkKey);
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
NetworkKeyRef GetNetworkKeyRef(void) const { return mNetworkKeyRef; }
void SetNetworkKeyRef(NetworkKeyRef aKeyRef);
#endif
bool IsPskcSet(void) const { return mIsPskcSet; }
void GetPskc(Pskc &aPskc) const;
void SetPskc(const Pskc &aPskc);
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
const PskcRef &GetPskcRef(void) const { return mPskcRef; }
void SetPskcRef(PskcRef aKeyRef);
#endif
uint32_t GetCurrentKeySequence(void) const { return mKeySequence; }
void SetCurrentKeySequence(uint32_t aKeySequence, KeySeqUpdateFlags aFlags);
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
const Mac::KeyMaterial &GetCurrentTrelMacKey(void) const { return mTrelKey; }
const Mac::KeyMaterial &GetTemporaryTrelMacKey(uint32_t aKeySequence);
#endif
const Mle::KeyMaterial &GetCurrentMleKey(void) const { return mMleKey; }
const Mle::KeyMaterial &GetTemporaryMleKey(uint32_t aKeySequence);
const Mle::KeyMaterial &GetTemporaryMacKey(uint32_t aKeySequence);
#if OPENTHREAD_CONFIG_RADIO_LINK_IEEE_802_15_4_ENABLE
uint32_t Get154MacFrameCounter(void) const { return mMacFrameCounters.Get154(); }
#endif
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
uint32_t GetTrelMacFrameCounter(void) const { return mMacFrameCounters.GetTrel(); }
void IncrementTrelMacFrameCounter(void);
#endif
uint32_t GetMaximumMacFrameCounter(void) const { return mMacFrameCounters.GetMaximum(); }
void SetAllMacFrameCounters(uint32_t aFrameCounter, bool aSetIfLarger);
void SetStoredMacFrameCounter(uint32_t aStoredMacFrameCounter) { mStoredMacFrameCounter = aStoredMacFrameCounter; }
uint32_t GetMleFrameCounter(void) const { return mMleFrameCounter; }
void SetMleFrameCounter(uint32_t aMleFrameCounter) { mMleFrameCounter = aMleFrameCounter; }
void SetStoredMleFrameCounter(uint32_t aStoredMleFrameCounter) { mStoredMleFrameCounter = aStoredMleFrameCounter; }
void IncrementMleFrameCounter(void);
const KekKeyMaterial &GetKek(void) const { return mKek; }
void ExtractKek(Kek &aKek) { mKek.ExtractKey(aKek); }
void SetKek(const Kek &aKek);
void SetKek(const uint8_t *aKekBytes) { SetKek(*reinterpret_cast<const Kek *>(aKekBytes)); }
uint32_t GetKekFrameCounter(void) const { return mKekFrameCounter; }
void IncrementKekFrameCounter(void) { mKekFrameCounter++; }
uint16_t GetKeySwitchGuardTime(void) const { return mKeySwitchGuardTime; }
void SetKeySwitchGuardTime(uint16_t aGuardTime) { mKeySwitchGuardTime = aGuardTime; }
const SecurityPolicy &GetSecurityPolicy(void) const { return mSecurityPolicy; }
void SetSecurityPolicy(const SecurityPolicy &aSecurityPolicy);
void UpdateKeyMaterial(void);
void MacFrameCounterUsed(uint32_t aMacFrameCounter);
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
void DestroyTemporaryKeys(void);
void DestroyPersistentKeys(void);
#endif
private:
static constexpr uint16_t kDefaultKeySwitchGuardTime = 624;
static constexpr uint32_t kKeySwitchGuardTimePercentage = 93;
static constexpr bool kExportableMacKeys = OPENTHREAD_CONFIG_PLATFORM_MAC_KEYS_EXPORTABLE_ENABLE;
static_assert(kDefaultKeySwitchGuardTime ==
SecurityPolicy::kDefaultKeyRotationTime * kKeySwitchGuardTimePercentage / 100,
"Default key switch guard time value is not correct");
OT_TOOL_PACKED_BEGIN
struct Keys
{
Mle::Key mMleKey;
Mac::Key mMacKey;
} OT_TOOL_PACKED_END;
union HashKeys
{
Crypto::HmacSha256::Hash mHash;
Keys mKeys;
const Mle::Key &GetMleKey(void) const { return mKeys.mMleKey; }
const Mac::Key &GetMacKey(void) const { return mKeys.mMacKey; }
};
void ComputeKeys(uint32_t aKeySequence, HashKeys &aHashKeys) const;
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
void ComputeTrelKey(uint32_t aKeySequence, Mac::Key &aKey) const;
#endif
void ResetKeyRotationTimer(void);
void HandleKeyRotationTimer(void);
void CheckForKeyRotation(void);
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
void StoreNetworkKey(const NetworkKey &aNetworkKey, bool aOverWriteExisting);
void StorePskc(const Pskc &aPskc);
#endif
void ResetFrameCounters(void);
using RotationTimer = TimerMilliIn<KeyManager, &KeyManager::HandleKeyRotationTimer>;
static const uint8_t kThreadString[];
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
static const uint8_t kHkdfExtractSaltString[];
static const uint8_t kTrelInfoString[];
#endif
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
NetworkKeyRef mNetworkKeyRef;
#else
NetworkKey mNetworkKey;
#endif
uint32_t mKeySequence;
Mle::KeyMaterial mMleKey;
Mle::KeyMaterial mTemporaryMleKey;
#if OPENTHREAD_CONFIG_WAKEUP_END_DEVICE_ENABLE
Mle::KeyMaterial mTemporaryMacKey;
#endif
#if OPENTHREAD_CONFIG_RADIO_LINK_TREL_ENABLE
Mac::KeyMaterial mTrelKey;
Mac::KeyMaterial mTemporaryTrelKey;
#endif
Mac::LinkFrameCounters mMacFrameCounters;
uint32_t mMleFrameCounter;
uint32_t mStoredMacFrameCounter;
uint32_t mStoredMleFrameCounter;
uint16_t mHoursSinceKeyRotation;
uint16_t mKeySwitchGuardTime;
uint16_t mKeySwitchGuardTimer;
RotationTimer mKeyRotationTimer;
#if OPENTHREAD_CONFIG_PLATFORM_KEY_REFERENCES_ENABLE
PskcRef mPskcRef;
#else
Pskc mPskc;
#endif
KekKeyMaterial mKek;
uint32_t mKekFrameCounter;
SecurityPolicy mSecurityPolicy;
bool mIsPskcSet : 1;
};
Fields
Field
Declared as
uint32_t
uint32_t
RotationTimer
uint32_t
bool : 1
References
Code
Location
Scope
Referrer
Class Tree
ot::KeyManager is inherited by 2 classess:
Instances
Instance
Scope
Location
Project