otSecurityPolicy

#include <openthread/dataset.h>

Represents Security Policy.

Summary

The mReservedBit*Cleared fields intentionally use inverted logic (false/0 means the bit is set to 1 in the Security Policy TLV, and true/1 means the bit is cleared to 0 in the TLV). Per the Thread specification, reserved bits in the Security Policy TLV default to 1. Using inverted logic ensures backward compatibility when callers zero-initialize otSecurityPolicy (or otOperationalDataset), so that unset reserved fields automatically encode to their specification-mandated default value of 1 in the TLV.

Public attributes
mAutonomousEnrollmentEnabled	bool Autonomous Enrollment is enabled.
mCommercialCommissioningEnabled	bool Commercial Commissioning is enabled.
mExternalCommissioningEnabled	bool External Commissioner authentication is allowed.
mNativeCommissioningEnabled	bool Native Commissioning using PSKc is allowed.
mNetworkKeyProvisioningEnabled	bool Network Key Provisioning is enabled.
mNonCcmRoutersEnabled	bool Non-CCM Routers enabled.
mObtainNetworkKeyEnabled	bool Obtaining the Network Key for out-of-band commissioning is enabled.
mReservedBit10Cleared	bool Reserved bit 10 (1 indicates bit is 0 in TLV)
mReservedBit11Cleared	bool Reserved bit 11 (1 indicates bit is 0 in TLV)
mReservedBit12Cleared	bool Reserved bit 12 (1 indicates bit is 0 in TLV)
mRotationTime	uint16_t The value for thrKeyRotation in units of hours.
mRoutersEnabled	bool Thread 1.0/1.1.x Routers are enabled.
mTobleLinkEnabled	bool ToBLE link is enabled.
mVersionThresholdForRouting	uint8_t Version-threshold for Routing.

Public attributes

mAutonomousEnrollmentEnabled

bool otSecurityPolicy::mAutonomousEnrollmentEnabled

Autonomous Enrollment is enabled.

mCommercialCommissioningEnabled

bool otSecurityPolicy::mCommercialCommissioningEnabled

Commercial Commissioning is enabled.

mExternalCommissioningEnabled

bool otSecurityPolicy::mExternalCommissioningEnabled

External Commissioner authentication is allowed.

mNativeCommissioningEnabled

bool otSecurityPolicy::mNativeCommissioningEnabled

Native Commissioning using PSKc is allowed.

mNetworkKeyProvisioningEnabled

bool otSecurityPolicy::mNetworkKeyProvisioningEnabled

Network Key Provisioning is enabled.

mNonCcmRoutersEnabled

bool otSecurityPolicy::mNonCcmRoutersEnabled

Non-CCM Routers enabled.

mObtainNetworkKeyEnabled

bool otSecurityPolicy::mObtainNetworkKeyEnabled

Obtaining the Network Key for out-of-band commissioning is enabled.

mReservedBit10Cleared

bool otSecurityPolicy::mReservedBit10Cleared

Reserved bit 10 (1 indicates bit is 0 in TLV)

mReservedBit11Cleared

bool otSecurityPolicy::mReservedBit11Cleared

Reserved bit 11 (1 indicates bit is 0 in TLV)

mReservedBit12Cleared

bool otSecurityPolicy::mReservedBit12Cleared

Reserved bit 12 (1 indicates bit is 0 in TLV)

mRotationTime

uint16_t otSecurityPolicy::mRotationTime

The value for thrKeyRotation in units of hours.

mRoutersEnabled

bool otSecurityPolicy::mRoutersEnabled

Thread 1.0/1.1.x Routers are enabled.

mTobleLinkEnabled

bool otSecurityPolicy::mTobleLinkEnabled

ToBLE link is enabled.

mVersionThresholdForRouting

uint8_t otSecurityPolicy::mVersionThresholdForRouting

Version-threshold for Routing.

Resources

OpenThread API Reference topics originate from the source code, available on GitHub. For more information, or to contribute to our documentation, refer to Resources.