ESP-IDF
ot::SecurityPolicy
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading (4/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::SecurityPolicy
ot::SecurityPolicy class
Represents Security Policy Rotation and Flags.
Syntax
Show:
Summary
Declaration
from
key_manager.hpp:70
class
SecurityPolicy
:
public
otSecurityPolicy
,
public
Equatable
<
SecurityPolicy
>
,
public
Clearable
<
SecurityPolicy
>
{
public
:
static
constexpr
uint8_t
kVersionThresholdOffsetVersion
=
3
;
static
constexpr
uint16_t
kDefaultKeyRotationTime
=
672
;
static
constexpr
uint16_t
kMinKeyRotationTime
=
2
;
SecurityPolicy
(
void
)
{
SetToDefault
(
)
;
}
void
SetToDefault
(
void
)
;
void
SetFlags
(
const
uint8_t
*
aFlags
,
uint8_t
aFlagsLength
)
;
void
GetFlags
(
uint8_t
*
aFlags
,
uint8_t
aFlagsLength
)
const
;
private
:
static
constexpr
uint8_t
kDefaultFlags
=
0xff
;
static
constexpr
uint8_t
kObtainNetworkKeyMask
=
1
<
<
7
;
static
constexpr
uint8_t
kNativeCommissioningMask
=
1
<
<
6
;
static
constexpr
uint8_t
kRoutersMask
=
1
<
<
5
;
static
constexpr
uint8_t
kExternalCommissioningMask
=
1
<
<
4
;
static
constexpr
uint8_t
kBeaconsMask
=
1
<
<
3
;
static
constexpr
uint8_t
kCommercialCommissioningMask
=
1
<
<
2
;
static
constexpr
uint8_t
kAutonomousEnrollmentMask
=
1
<
<
1
;
static
constexpr
uint8_t
kNetworkKeyProvisioningMask
=
1
<
<
0
;
static
constexpr
uint8_t
kTobleLinkMask
=
1
<
<
7
;
static
constexpr
uint8_t
kNonCcmRoutersMask
=
1
<
<
6
;
static
constexpr
uint8_t
kReservedMask
=
0x38
;
static
constexpr
uint8_t
kVersionThresholdForRoutingMask
=
0x07
;
void
SetToDefaultFlags
(
void
)
;
}
;
Fields
Field
Description
ot::SecurityPolicy::kVersionThresholdOffsetVersion
Offset between the Thread Version and the Version-threshold valid for Routing.
ot::SecurityPolicy::kDefaultKeyRotationTime
Default Key Rotation Time (in unit of hours).
ot::SecurityPolicy::kMinKeyRotationTime
Minimum Key Rotation Time (in unit of hours).
ot::SecurityPolicy::kDefaultFlags
ot::SecurityPolicy::kObtainNetworkKeyMask
ot::SecurityPolicy::kNativeCommissioningMask
ot::SecurityPolicy::kRoutersMask
ot::SecurityPolicy::kExternalCommissioningMask
ot::SecurityPolicy::kBeaconsMask
ot::SecurityPolicy::kCommercialCommissioningMask
ot::SecurityPolicy::kAutonomousEnrollmentMask
ot::SecurityPolicy::kNetworkKeyProvisioningMask
ot::SecurityPolicy::kTobleLinkMask
ot::SecurityPolicy::kNonCcmRoutersMask
ot::SecurityPolicy::kReservedMask
ot::SecurityPolicy::kVersionThresholdForRoutingMask
Methods
SetToDefault()
Sets the Security Policy to default values.
SetFlags()
Sets the Security Policy Flags.
GetFlags() const
Returns the Security Policy Flags.
SetToDefaultFlags()
Related Functions
Found 2 other functions taking a
SecurityPolicy
argument:
Function
Description
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()
Sets the Security Policy.
ot::KeyManager::SetSecurityPolicy()
Sets the Security Policy. The Security Policy specifies Key Rotation Time and network administrator preferences for which security-related operations are allowed or disallowed.
Examples
References
from
examples
Code
Location
Scope
Referrer
class
SecurityPolicy
:
public
otSecurityPolicy
,
public
Equatable
<
SecurityPolicy
>
,
public
Clearable
<
SecurityPolicy
>
key_manager.hpp:70
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kActiveTimestamp
>
{
using
Type
=
Timestamp
;
}
;
dataset.hpp:700
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPendingTimestamp
>
{
using
Type
=
Timestamp
;
}
;
dataset.hpp:701
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kNetworkKey
>
{
using
Type
=
NetworkKey
;
}
;
dataset.hpp:702
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kNetworkName
>
{
using
Type
=
NetworkName
;
}
;
dataset.hpp:703
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kExtendedPanId
>
{
using
Type
=
ExtendedPanId
;
}
;
dataset.hpp:704
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kMeshLocalPrefix
>
{
using
Type
=
Ip6
::
NetworkPrefix
;
}
;
dataset.hpp:705
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kDelay
>
{
using
Type
=
uint32_t
;
}
;
dataset.hpp:706
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPanId
>
{
using
Type
=
Mac
::
PanId
;
}
;
dataset.hpp:707
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kChannel
>
{
using
Type
=
uint16_t
;
}
;
dataset.hpp:708
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kWakeupChannel
>
{
using
Type
=
uint16_t
;
}
;
dataset.hpp:709
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kPskc
>
{
using
Type
=
Pskc
;
}
;
dataset.hpp:710
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kSecurityPolicy
>
{
using
Type
=
SecurityPolicy
;
}
;
dataset.hpp:711
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kChannelMask
>
{
using
Type
=
uint32_t
;
}
;
dataset.hpp:712
DefineCoreType
(
otSecurityPolicy
,
SecurityPolicy
)
;
key_manager.hpp:646
template
<
>
struct
Dataset
::
TypeFor
<
Dataset
::
kSecurityPolicy
>
{
using
Type
=
SecurityPolicy
;
}
;
dataset.hpp:711
ot::MeshCoP::Dataset::TypeFor::Type
template
<
>
inline
const
SecurityPolicy
&
Dataset
::
Info
::
Get
<
Dataset
::
kSecurityPolicy
>
(
void
)
const
dataset.hpp:749
ot::MeshCoP::Dataset::Info
ot::MeshCoP::Dataset::Info::Get() const
void
SecurityPolicy
::
SetToDefault
(
void
)
key_manager.cpp:59
ot::SecurityPolicy::SetToDefault()
void
SecurityPolicy
::
SetToDefaultFlags
(
void
)
key_manager.cpp:66
ot::SecurityPolicy::SetToDefaultFlags()
void
SecurityPolicy
::
SetFlags
(
const
uint8_t
*
aFlags
,
uint8_t
aFlagsLength
)
key_manager.cpp:80
ot::SecurityPolicy::SetFlags()
void
SecurityPolicy
::
GetFlags
(
uint8_t
*
aFlags
,
uint8_t
aFlagsLength
)
const
key_manager.cpp:103
ot::SecurityPolicy::GetFlags() const
void
KeyManager
::
SetSecurityPolicy
(
const
SecurityPolicy
&
aSecurityPolicy
)
key_manager.cpp:489
ot::KeyManager::SetSecurityPolicy()
ot::KeyManager::SetSecurityPolicy()::aSecurityPolicy
SecurityPolicy
newPolicy
=
aSecurityPolicy
;
key_manager.cpp:491
ot::KeyManager::SetSecurityPolicy()
if
(
newPolicy
.
mRotationTime
<
SecurityPolicy
::
kMinKeyRotationTime
)
key_manager.cpp:493
ot::KeyManager::SetSecurityPolicy()
newPolicy
.
mRotationTime
=
SecurityPolicy
::
kMinKeyRotationTime
;
key_manager.cpp:495
ot::KeyManager::SetSecurityPolicy()
const
SecurityPolicy
&
GetSecurityPolicy
(
void
)
const
{
return
mSecurityPolicy
;
}
key_manager.hpp:511
ot::KeyManager
ot::KeyManager::GetSecurityPolicy() const
void
SetSecurityPolicy
(
const
SecurityPolicy
&
aSecurityPolicy
)
;
key_manager.hpp:521
ot::KeyManager::SetSecurityPolicy()
ot::KeyManager::SetSecurityPolicy()::aSecurityPolicy
SecurityPolicy
::
kDefaultKeyRotationTime
*
kKeySwitchGuardTimePercentage
/
100
,
key_manager.hpp:555
SecurityPolicy
mSecurityPolicy
;
key_manager.hpp:638
ot::KeyManager
ot::KeyManager::mSecurityPolicy
DefineCoreType
(
otSecurityPolicy
,
SecurityPolicy
)
;
key_manager.hpp:646
ot::CoreType::Type
SecurityPolicy
SecurityPolicyTlv
::
GetSecurityPolicy
(
void
)
const
meshcop_tlvs.cpp:74
ot::MeshCoP::SecurityPolicyTlv
ot::MeshCoP::SecurityPolicyTlv::GetSecurityPolicy() const
SecurityPolicy
securityPolicy
;
meshcop_tlvs.cpp:76
ot::MeshCoP::SecurityPolicyTlv::GetSecurityPolicy() const
void
SecurityPolicyTlv
::
SetSecurityPolicy
(
const
SecurityPolicy
&
aSecurityPolicy
)
meshcop_tlvs.cpp:85
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()::aSecurityPolicy
SecurityPolicy
GetSecurityPolicy
(
void
)
const
;
meshcop_tlvs.hpp:480
ot::MeshCoP::SecurityPolicyTlv
ot::MeshCoP::SecurityPolicyTlv::GetSecurityPolicy() const
void
SetSecurityPolicy
(
const
SecurityPolicy
&
aSecurityPolicy
)
;
meshcop_tlvs.hpp:487
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()::aSecurityPolicy
const
SecurityPolicy
&
secPolicy
=
Get
<
KeyManager
>
(
)
.
GetSecurityPolicy
(
)
;
mle_router.cpp:105
ot::Mle::MleRouter::IsRouterEligible() const
secPolicy
.
mVersionThresholdForRouting
+
SecurityPolicy
::
kVersionThresholdOffsetVersion
<=
mle_router.cpp:124
ot::Mle::MleRouter::IsRouterEligible() const
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::SecurityPolicy
is inherited by 1 classes:
All items filtered out
ot::SecurityPolicy
otSecurityPolicy
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::KeyManager::GetSecurityPolicy() const
key_manager.hpp:511
ot::KeyManager::SetSecurityPolicy()::aSecurityPolicy
ot::KeyManager::SetSecurityPolicy()
key_manager.hpp:521
ot::KeyManager::mSecurityPolicy
ot::KeyManager
key_manager.hpp:638
ot::CoreType::Type
key_manager.hpp:646
ot::MeshCoP::Dataset::TypeFor::Type
dataset.hpp:711
return
ot::MeshCoP::Dataset::Info::Get() const
dataset.hpp:749
return
ot::MeshCoP::SecurityPolicyTlv::GetSecurityPolicy() const
meshcop_tlvs.hpp:480
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()::aSecurityPolicy
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()
meshcop_tlvs.hpp:487
ot::KeyManager::SetSecurityPolicy()::aSecurityPolicy
ot::KeyManager::SetSecurityPolicy()
key_manager.cpp:489
return
ot::MeshCoP::SecurityPolicyTlv::GetSecurityPolicy() const
meshcop_tlvs.cpp:74
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()::aSecurityPolicy
ot::MeshCoP::SecurityPolicyTlv::SetSecurityPolicy()
meshcop_tlvs.cpp:85
Lifecycle
from
examples
All items filtered out
All items filtered out