ESP-IDF
ot::Mac::Key
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading (3/5)...
Files
loading (4/5)...
Summary
Syntax
Methods
Related
Examples
References
Call Tree
Data Use
Class Tree
Override Tree
Implementations
Instances
Lifecycle
SourceVu
ESP-IDF Framework and Examples
ESP-IDF
ot::Mac::Key
ot::Mac::Key class
Syntax
Show:
Summary
Declaration
from
mac_types.hpp:460
class
Key
:
public
otMacKey
,
public
Equatable
<
Key
>
,
public
Clearable
<
Key
>
{
public
:
static
constexpr
uint16_t
kSize
=
OT_MAC_KEY_SIZE
;
const
uint8_t
*
GetBytes
(
void
)
const
{
return
m8
;
}
}
;
Fields
Field
ot::Mac::Key::kSize
Methods
GetBytes() const
Gets a pointer to the bytes array containing the key.
Related Functions
Found 8 other functions taking a
Key
argument:
Function
Description
ot::Mac::KeyMaterial::SetFrom()
Sets the `KeyMaterial` from a given Key. If the `KeyMaterial` currently stores a valid `KeyRef`, the `SetFrom()` call will ensure to delete the previous one before creating and using a new `KeyRef` associated with the new `Key`.
ot::KeyManager::SetKek()
Sets the KEK.
ot::KeyManager::ComputeTrelKey() const
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()
ot::Mac::KeyMaterial::SetKey()
ot::Mac::KeyMaterial::ExtractKey() const
Extracts the literal key from `KeyMaterial`
ot::Mac::LinkRaw::SetMacKey()
Updates MAC keys and key index.
ot::KeyManager::ExtractKek()
Retrieves the KEK as literal `Kek` key.
Examples
References
from
examples
Code
Location
Scope
Referrer
typedef
Mac
::
Key
Kek
;
key_manager.hpp:192
class
Key
:
public
otMacKey
,
public
Equatable
<
Key
>
,
public
Clearable
<
Key
>
mac_types.hpp:460
typedef
Mac
::
Key
Key
;
mle_types.hpp:563
DefineCoreType
(
otCacheEntryIterator
,
AddressResolver
::
Iterator
)
;
address_resolver.hpp:400
DefineCoreType
(
otCacheEntryInfo
,
AddressResolver
::
EntryInfo
)
;
address_resolver.hpp:401
DefineCoreType
(
otBorderAgentId
,
MeshCoP
::
BorderAgent
::
Id
)
;
border_agent.hpp:353
DefineCoreType
(
otChildInfo
,
Child
::
Info
)
;
child.hpp:399
DefineCoreType
(
otCoapTxParameters
,
Coap
::
TxParameters
)
;
coap.hpp:941
DefineCoreType
(
otCoapResource
,
Coap
::
Resource
)
;
coap.hpp:942
DefineCoreType
(
otCoapOption
,
Coap
::
Option
)
;
coap_message.hpp:1175
DefineCoreType
(
otCoapOptionIterator
,
Coap
::
Option
::
Iterator
)
;
coap_message.hpp:1176
DefineCoreType
(
otOperationalDatasetComponents
,
MeshCoP
::
Dataset
::
Components
)
;
dataset.hpp:783
DefineCoreType
(
otOperationalDataset
,
MeshCoP
::
Dataset
::
Info
)
;
dataset.hpp:784
DefineCoreType
(
otDnsQueryConfig
,
Dns
::
Client
::
QueryConfig
)
;
dns_client.hpp:892
DefineCoreType
(
otDnsAddressResponse
,
Dns
::
Client
::
AddressResponse
)
;
dns_client.hpp:893
DefineCoreType
(
otDnsBrowseResponse
,
Dns
::
Client
::
BrowseResponse
)
;
dns_client.hpp:895
DefineCoreType
(
otDnsServiceResponse
,
Dns
::
Client
::
ServiceResponse
)
;
dns_client.hpp:896
DefineCoreType
(
otDnsServiceInfo
,
Dns
::
Client
::
ServiceInfo
)
;
dns_client.hpp:897
DefineCoreType
(
otDnsTxtEntry
,
Dns
::
TxtEntry
)
;
dns_types.hpp:2734
DefineCoreType
(
otDnsTxtEntryIterator
,
Dns
::
TxtEntry
::
Iterator
)
;
dns_types.hpp:2735
DefineCoreType
(
otPlatCryptoEcdsaSignature
,
Crypto
::
Ecdsa
::
P256
::
Signature
)
;
ecdsa.hpp:340
DefineCoreType
(
otPlatCryptoEcdsaKeyPair
,
Crypto
::
Ecdsa
::
P256
::
KeyPair
)
;
ecdsa.hpp:341
DefineCoreType
(
otPlatCryptoEcdsaPublicKey
,
Crypto
::
Ecdsa
::
P256
::
PublicKey
)
;
ecdsa.hpp:342
DefineCoreType
(
otExtendedPanId
,
MeshCoP
::
ExtendedPanId
)
;
extended_panid.hpp:106
DefineCoreType
(
otIcmp6Header
,
Ip6
::
Icmp
::
Header
)
;
icmp6.hpp:337
DefineCoreType
(
otIcmp6Handler
,
Ip6
::
Icmp
::
Handler
)
;
icmp6.hpp:338
DefineCoreType
(
otInstance
,
Instance
)
;
instance.hpp:741
DefineCoreType
(
otBufferInfo
,
Instance
::
BufferInfo
)
;
instance.hpp:742
DefineCoreType
(
otIp4Address
,
Ip4
::
Address
)
;
ip4_types.hpp:661
DefineCoreType
(
otIp4Cidr
,
Ip4
::
Cidr
)
;
ip4_types.hpp:662
DefineCoreType
(
otIp6NetworkPrefix
,
Ip6
::
NetworkPrefix
)
;
ip6_address.hpp:986
DefineCoreType
(
otIp6Prefix
,
Ip6
::
Prefix
)
;
ip6_address.hpp:987
DefineCoreType
(
otIp6InterfaceIdentifier
,
Ip6
::
InterfaceIdentifier
)
;
ip6_address.hpp:988
DefineCoreType
(
otIp6Address
,
Ip6
::
Address
)
;
ip6_address.hpp:989
DefineCoreType
(
otSecurityPolicy
,
SecurityPolicy
)
;
key_manager.hpp:646
DefineCoreType
(
otNetworkKey
,
NetworkKey
)
;
key_manager.hpp:647
DefineCoreType
(
otPskc
,
Pskc
)
;
key_manager.hpp:648
DefineCoreType
(
otExtAddress
,
Mac
::
ExtAddress
)
;
mac_types.hpp:923
DefineCoreType
(
otMacKey
,
Mac
::
Key
)
;
mac_types.hpp:924
DefineCoreType
(
otMeshDiagIp6AddrIterator
,
Utils
::
MeshDiag
::
Ip6AddrIterator
)
;
mesh_diag.hpp:314
DefineCoreType
(
otMeshDiagRouterInfo
,
Utils
::
MeshDiag
::
RouterInfo
)
;
mesh_diag.hpp:315
DefineCoreType
(
otMeshDiagChildInfo
,
Utils
::
MeshDiag
::
ChildInfo
)
;
mesh_diag.hpp:316
DefineCoreType
(
otMeshDiagChildIterator
,
Utils
::
MeshDiag
::
ChildIterator
)
;
mesh_diag.hpp:317
DefineCoreType
(
otThreadLinkInfo
,
ThreadLinkInfo
)
;
mesh_forwarder.hpp:662
DefineCoreType
(
otJoinerPskd
,
MeshCoP
::
JoinerPskd
)
;
meshcop.hpp:515
DefineCoreType
(
otJoinerDiscerner
,
MeshCoP
::
JoinerDiscerner
)
;
meshcop.hpp:516
DefineCoreType
(
otSteeringData
,
MeshCoP
::
SteeringData
)
;
meshcop.hpp:517
DefineCoreType
(
otCommissioningDataset
,
MeshCoP
::
CommissioningDataset
)
;
meshcop.hpp:518
DefineCoreType
(
otMessageBuffer
,
Buffer
)
;
message.hpp:1901
DefineCoreType
(
otMessageSettings
,
Message
::
Settings
)
;
message.hpp:1902
DefineCoreType
(
otMessage
,
Message
)
;
message.hpp:1903
DefineCoreType
(
otMessageQueue
,
MessageQueue
)
;
message.hpp:1904
DefineCoreType
(
otLeaderData
,
Mle
::
LeaderData
)
;
mle_types.hpp:699
DefineCoreType
(
otDeviceProperties
,
Mle
::
DeviceProperties
)
;
mle_types.hpp:702
DefineCoreType
(
otNeighborInfo
,
Neighbor
::
Info
)
;
neighbor.hpp:773
DefineCoreType
(
otNetifAddress
,
Ip6
::
Netif
::
UnicastAddress
)
;
netif.hpp:652
DefineCoreType
(
otNetifMulticastAddress
,
Ip6
::
Netif
::
MulticastAddress
)
;
netif.hpp:653
DefineCoreType
(
otBorderRouterConfig
,
NetworkData
::
OnMeshPrefixConfig
)
;
network_data_types.hpp:400
DefineCoreType
(
otExternalRouteConfig
,
NetworkData
::
ExternalRouteConfig
)
;
network_data_types.hpp:401
DefineCoreType
(
otLowpanContextInfo
,
NetworkData
::
LowpanContextInfo
)
;
network_data_types.hpp:402
DefineCoreType
(
otServiceConfig
,
NetworkData
::
ServiceConfig
)
;
network_data_types.hpp:403
DefineCoreType
(
otServerConfig
,
NetworkData
::
ServiceConfig
::
ServerConfig
)
;
network_data_types.hpp:404
DefineCoreType
(
otNetworkName
,
MeshCoP
::
NetworkName
)
;
network_name.hpp:262
DefineCoreType
(
otPingSenderReply
,
Utils
::
PingSender
::
Reply
)
;
ping_sender.hpp:179
DefineCoreType
(
otPingSenderConfig
,
Utils
::
PingSender
::
Config
)
;
ping_sender.hpp:180
DefineCoreType
(
otPingSenderStatistics
,
Utils
::
PingSender
::
Statistics
)
;
ping_sender.hpp:181
DefineCoreType
(
otRouterInfo
,
Router
::
Info
)
;
router.hpp:215
DefineCoreType
(
otCryptoSha256Hash
,
Crypto
::
Sha256
::
Hash
)
;
sha256.hpp:148
DefineCoreType
(
otMessageInfo
,
Ip6
::
MessageInfo
)
;
socket.hpp:326
DefineCoreType
(
otSockAddr
,
Ip6
::
SockAddr
)
;
socket.hpp:327
DefineCoreType
(
otSrpClientHostInfo
,
Srp
::
Client
::
HostInfo
)
;
srp_client.hpp:1116
DefineCoreType
(
otSrpClientService
,
Srp
::
Client
::
Service
)
;
srp_client.hpp:1117
DefineCoreType
(
otSrpClientBuffersServiceEntry
,
Utils
::
SrpClientBuffers
::
ServiceEntry
)
;
srp_client_buffers.hpp:248
DefineCoreType
(
otSrpServerTtlConfig
,
Srp
::
Server
::
TtlConfig
)
;
srp_server.hpp:1019
DefineCoreType
(
otSrpServerLeaseConfig
,
Srp
::
Server
::
LeaseConfig
)
;
srp_server.hpp:1020
DefineCoreType
(
otSrpServerHost
,
Srp
::
Server
::
Host
)
;
srp_server.hpp:1021
DefineCoreType
(
otSrpServerService
,
Srp
::
Server
::
Service
)
;
srp_server.hpp:1022
DefineCoreType
(
otCryptoKey
,
Crypto
::
Key
)
;
storage.hpp:323
DefineCoreType
(
otTcpEndpoint
,
Ip6
::
Tcp
::
Endpoint
)
;
tcp6.hpp:670
DefineCoreType
(
otTcpListener
,
Ip6
::
Tcp
::
Listener
)
;
tcp6.hpp:671
DefineCoreType
(
otTcpCircularSendBuffer
,
Ip6
::
TcpCircularSendBuffer
)
;
tcp6_ext.hpp:129
DefineCoreType
(
otUdpSocket
,
Ip6
::
Udp
::
SocketHandle
)
;
udp6.hpp:669
DefineCoreType
(
otUdpReceiver
,
Ip6
::
Udp
::
Receiver
)
;
udp6.hpp:670
Kek
kek
;
joiner_router.cpp:161
ot::MeshCoP::JoinerRouter::HandleTmf()
void
JoinerRouter
::
DelaySendingJoinerEntrust
(
const
Ip6
::
MessageInfo
&
aMessageInfo
,
const
Kek
&
aKek
)
joiner_router.cpp:196
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()::aKek
Kek
mKek
;
// KEK used by MAC layer to encode this message.
joiner_router.hpp:92
ot::MeshCoP::JoinerRouter::JoinerEntrustMetadata
ot::MeshCoP::JoinerRouter::JoinerEntrustMetadata::mKek
void
DelaySendingJoinerEntrust
(
const
Ip6
::
MessageInfo
&
aMessageInfo
,
const
Kek
&
aKek
)
;
joiner_router.hpp:110
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()::aKek
void
KeyManager
::
ComputeTrelKey
(
uint32_t
aKeySequence
,
Mac
::
Key
&
aKey
)
const
key_manager.cpp:309
ot::KeyManager::ComputeTrelKey() const
ot::KeyManager::ComputeTrelKey() const::aKey
hkdf
.
Expand
(
kTrelInfoString
,
sizeof
(
kTrelInfoString
)
,
aKey
.
m8
,
Mac
::
Key
::
kSize
)
;
key_manager.cpp:325
ot::KeyManager::ComputeTrelKey() const
Mac
::
Key
key
;
key_manager.cpp:357
ot::KeyManager::UpdateKeyMaterial()
Mac
::
Key
key
;
key_manager.cpp:418
ot::KeyManager::GetTemporaryTrelMacKey()
void
KeyManager
::
SetKek
(
const
Kek
&
aKek
)
key_manager.cpp:483
ot::KeyManager::SetKek()
ot::KeyManager::SetKek()::aKek
typedef
Mac
::
Key
Kek
;
key_manager.hpp:192
ot::Kek
void
ExtractKek
(
Kek
&
aKek
)
{
mKek
.
ExtractKey
(
aKek
)
;
}
key_manager.hpp:455
ot::KeyManager::ExtractKek()
ot::KeyManager::ExtractKek()::aKek
void
SetKek
(
const
Kek
&
aKek
)
;
key_manager.hpp:462
ot::KeyManager::SetKek()
ot::KeyManager::SetKek()::aKek
void
SetKek
(
const
uint8_t
*
aKekBytes
)
{
SetKek
(
*
reinterpret_cast
<
const
Kek
*
>
(
aKekBytes
)
)
;
}
key_manager.hpp:469
ot::KeyManager::SetKek()
Mle
::
Key
mMleKey
;
key_manager.hpp:561
ot::KeyManager::Keys
ot::KeyManager::Keys::mMleKey
Mac
::
Key
mMacKey
;
key_manager.hpp:562
ot::KeyManager::Keys
ot::KeyManager::Keys::mMacKey
const
Mle
::
Key
&
GetMleKey
(
void
)
const
{
return
mKeys
.
mMleKey
;
}
key_manager.hpp:570
ot::KeyManager::HashKeys
ot::KeyManager::HashKeys::GetMleKey() const
const
Mac
::
Key
&
GetMacKey
(
void
)
const
{
return
mKeys
.
mMacKey
;
}
key_manager.hpp:571
ot::KeyManager::HashKeys
ot::KeyManager::HashKeys::GetMacKey() const
void
ComputeTrelKey
(
uint32_t
aKeySequence
,
Mac
::
Key
&
aKey
)
const
;
key_manager.hpp:577
ot::KeyManager::ComputeTrelKey() const
ot::KeyManager::ComputeTrelKey() const::aKey
const
Key
&
aPrevKey
,
link_raw.cpp:234
ot::Mac::LinkRaw::SetMacKey()
ot::Mac::LinkRaw::SetMacKey()::aPrevKey
const
Key
&
aCurrKey
,
link_raw.cpp:235
ot::Mac::LinkRaw::SetMacKey()
ot::Mac::LinkRaw::SetMacKey()::aCurrKey
const
Key
&
aNextKey
)
link_raw.cpp:236
ot::Mac::LinkRaw::SetMacKey()
ot::Mac::LinkRaw::SetMacKey()::aNextKey
Error
SetMacKey
(
uint8_t
aKeyIdMode
,
uint8_t
aKeyId
,
const
Key
&
aPrevKey
,
const
Key
&
aCurrKey
,
const
Key
&
aNextKey
)
;
link_raw.hpp:247
ot::Mac::LinkRaw::SetMacKey()
ot::Mac::LinkRaw::SetMacKey()::aPrevKey
void
KeyMaterial
::
SetFrom
(
const
Key
&
aKey
,
bool
aIsExportable
)
mac_types.cpp:292
ot::Mac::KeyMaterial::SetFrom()
ot::Mac::KeyMaterial::SetFrom()::aKey
void
KeyMaterial
::
ExtractKey
(
Key
&
aKey
)
const
mac_types.cpp:314
ot::Mac::KeyMaterial::ExtractKey() const
ot::Mac::KeyMaterial::ExtractKey() const::aKey
aCryptoKey
.
Set
(
GetKey
(
)
.
GetBytes
(
)
,
Key
::
kSize
)
;
mac_types.cpp:335
ot::Mac::KeyMaterial::ConvertToCryptoKey() const
const
Key
&
GetKey
(
void
)
const
{
return
static_cast
<
const
Key
&
>
(
mKeyMaterial
.
mKey
)
;
}
mac_types.hpp:526
ot::Mac::KeyMaterial::GetKey() const
void
SetFrom
(
const
Key
&
aKey
,
bool
aIsExportable
=
false
)
;
mac_types.hpp:547
ot::Mac::KeyMaterial::SetFrom()
ot::Mac::KeyMaterial::SetFrom()::aKey
void
ExtractKey
(
Key
&
aKey
)
const
;
mac_types.hpp:554
ot::Mac::KeyMaterial::ExtractKey() const
ot::Mac::KeyMaterial::ExtractKey() const::aKey
Key
&
GetKey
(
void
)
{
return
static_cast
<
Key
&
>
(
mKeyMaterial
.
mKey
)
;
}
mac_types.hpp:580
ot::Mac::KeyMaterial::GetKey()
void
SetKey
(
const
Key
&
aKey
)
{
mKeyMaterial
.
mKey
=
aKey
;
}
mac_types.hpp:581
ot::Mac::KeyMaterial::SetKey()
ot::Mac::KeyMaterial::SetKey()::aKey
DefineCoreType
(
otMacKey
,
Mac
::
Key
)
;
mac_types.hpp:924
ot::CoreType::Type
typedef
SimpleTlvInfo
<
Tlv
::
kJoinerRouterKek
,
Kek
>
JoinerRouterKekTlv
;
meshcop_tlvs.hpp:205
typedef
Mac
::
Key
Key
;
mle_types.hpp:563
ot::Mle::Key
Call Tree
from
examples
All items filtered out
All items filtered out
Data Use
from
examples
All items filtered out
All items filtered out
Class Tree
from
examples
ot::Mac::Key
is inherited by 1 classes:
All items filtered out
ot::Mac::Key
otMacKey
All items filtered out
Override Tree
from
examples
All items filtered out
All items filtered out
Implementations
from
examples
All items filtered out
All items filtered out
Instances
from
examples
Instance
Scope
Location
Project
return
ot::Mac::KeyMaterial::GetKey() const
mac_types.hpp:526
ot::Mac::KeyMaterial::SetFrom()::aKey
ot::Mac::KeyMaterial::SetFrom()
mac_types.hpp:547
ot::Mac::KeyMaterial::ExtractKey() const::aKey
ot::Mac::KeyMaterial::ExtractKey() const
mac_types.hpp:554
return
ot::Mac::KeyMaterial::GetKey()
mac_types.hpp:580
ot::Mac::KeyMaterial::SetKey()::aKey
ot::Mac::KeyMaterial::SetKey()
mac_types.hpp:581
ot::CoreType::Type
mac_types.hpp:924
ot::KeyManager::ExtractKek()::aKek
ot::KeyManager::ExtractKek()
key_manager.hpp:455
ot::KeyManager::SetKek()::aKek
ot::KeyManager::SetKek()
key_manager.hpp:462
ot::KeyManager::Keys::mMleKey
ot::KeyManager::Keys
key_manager.hpp:561
ot::KeyManager::Keys::mMacKey
ot::KeyManager::Keys
key_manager.hpp:562
return
ot::KeyManager::HashKeys::GetMleKey() const
key_manager.hpp:570
return
ot::KeyManager::HashKeys::GetMacKey() const
key_manager.hpp:571
ot::KeyManager::ComputeTrelKey() const::aKey
ot::KeyManager::ComputeTrelKey() const
key_manager.hpp:577
ot::Mac::LinkRaw::SetMacKey()::aPrevKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.hpp:247
ot::Mac::LinkRaw::SetMacKey()::aCurrKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.hpp:247
ot::Mac::LinkRaw::SetMacKey()::aNextKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.hpp:247
ot::MeshCoP::JoinerRouter::JoinerEntrustMetadata::mKek
ot::MeshCoP::JoinerRouter::JoinerEntrustMetadata
joiner_router.hpp:92
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()::aKek
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()
joiner_router.hpp:110
ot::Mac::LinkRaw::SetMacKey()::aPrevKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.cpp:234
ot::Mac::LinkRaw::SetMacKey()::aCurrKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.cpp:235
ot::Mac::LinkRaw::SetMacKey()::aNextKey
ot::Mac::LinkRaw::SetMacKey()
link_raw.cpp:236
ot::Mac::KeyMaterial::SetFrom()::aKey
ot::Mac::KeyMaterial::SetFrom()
mac_types.cpp:292
ot::Mac::KeyMaterial::ExtractKey() const::aKey
ot::Mac::KeyMaterial::ExtractKey() const
mac_types.cpp:314
ot::KeyManager::ComputeTrelKey() const::aKey
ot::KeyManager::ComputeTrelKey() const
key_manager.cpp:309
ot::KeyManager::SetKek()::aKek
ot::KeyManager::SetKek()
key_manager.cpp:483
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()::aKek
ot::MeshCoP::JoinerRouter::DelaySendingJoinerEntrust()
joiner_router.cpp:196
Lifecycle
from
examples
All items filtered out
All items filtered out