ESP-IDF
ot::SecurityPolicy
is only used within ESP-IDF.
Symbol previews are coming soon...
Symbols
loading...
Files
loading...
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
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
All items filtered out
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
Lifecycle
from
examples
All items filtered out
All items filtered out