direct_bt::SMPSecurityReqMsg Class Reference

Vol 3, Part H: 3.6.7 Security Request message. More...

#include <SMPTypes.hpp>

Inheritance diagram for direct_bt::SMPSecurityReqMsg:

Collaboration diagram for direct_bt::SMPSecurityReqMsg:

Public Member Functions
	SMPSecurityReqMsg (const uint8_t *source, const jau::nsize_t length)
	SMPSecurityReqMsg (const SMPAuthReqs auth_req_mask)
constexpr_cxx20 jau::nsize_t	getDataSize () const noexcept override
	Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets. More...
constexpr SMPAuthReqs	getAuthReqMask () const noexcept
	Returns the SMPPairingMsg::AuthRequirements (1 octet) More...
constexpr bool	isAuthRequirementBitSet (const SMPAuthReqs bit) const noexcept
constexpr_cxx20 std::string	getName () const noexcept override
Public Member Functions inherited from direct_bt::SMPPDUMsg
	SMPPDUMsg (const uint8_t *source, const jau::nsize_t size)
	Persistent memory, w/ ownership . More...
	SMPPDUMsg (const Opcode opc, const jau::nsize_t size)
	Persistent memory, w/ ownership . More...
virtual	~SMPPDUMsg () noexcept
constexpr uint64_t	getTimestamp () const noexcept
constexpr Opcode	getOpcode () const noexcept
	SMP Command Codes Vol 3, Part H (SM): 3.3. More...
constexpr jau::nsize_t	getPDUParamSize () const noexcept
	Returns the actual PDU size less one octet for the opcode, which should result in 0-22 octets or 64 octets. More...
constexpr jau::nsize_t	getDataOffset () const noexcept
	Returns the octet offset to the data segment in this PDU including the mandatory opcode, i.e. More...
virtual std::string	toString () const noexcept

Protected Member Functions
std::string	valueString () const noexcept override
Protected Member Functions inherited from direct_bt::SMPPDUMsg
void	checkOpcode (const Opcode expected) const
void	checkOpcode (const Opcode exp1, const Opcode exp2) const
virtual std::string	baseString () const noexcept

Additional Inherited Members
Public Types inherited from direct_bt::SMPPDUMsg
enum	Opcode : uint8_t {   Opcode::UNDEFINED = 0x00, Opcode::PAIRING_REQUEST = 0x01, Opcode::PAIRING_RESPONSE = 0x02, Opcode::PAIRING_CONFIRM = 0x03,   Opcode::PAIRING_RANDOM = 0x04, Opcode::PAIRING_FAILED = 0x05, Opcode::ENCRYPTION_INFORMATION = 0x06, Opcode::MASTER_IDENTIFICATION = 0x07,   Opcode::IDENTITY_INFORMATION = 0x08, Opcode::IDENTITY_ADDRESS_INFORMATION = 0x09, Opcode::SIGNING_INFORMATION = 0x0A, Opcode::SECURITY_REQUEST = 0x0B,   Opcode::PAIRING_PUBLIC_KEY = 0x0C, Opcode::PAIRING_DHKEY_CHECK = 0x0D, Opcode::PAIRING_KEYPRESS_NOTIFICATION = 0x0E }
	SMP Command Codes Vol 3, Part H (SM): 3.3. More...
Static Public Member Functions inherited from direct_bt::SMPPDUMsg
static constexpr uint8_t	number (const Opcode rhs) noexcept
static std::string	getOpcodeString (const Opcode opc) noexcept
static std::unique_ptr< const SMPPDUMsg >	getSpecialized (const uint8_t *buffer, jau::nsize_t const buffer_size) noexcept
	Return a newly created specialized instance pointer to base class. More...
template<class T >
static T *	clone (const T &source) noexcept
	Clone template for convenience, based on derived class's copy-constructor. More...
Protected Attributes inherited from direct_bt::SMPPDUMsg
POctets	pdu
	actual received PDU More...
uint64_t	ts_creation
	creation timestamp in milliseconds More...

Detailed Description

Vol 3, Part H: 3.6.7 Security Request message.

Vol 3 (Host), Part H (SM): 3 (SMP), 3.6 SECURITY IN BLUETOOTH LOW ENERGY

Opcode::SECURITY_REQUEST

[uint8_t opcode]
uint8_t auth_req_mask

Message is used by the slave to request that the master initiates security with the requested security properties,
see Vol 3 (Host), Part H (SM): 2 (SM), 2.4 SECURITY IN BLUETOOTH LOW ENERGY, 2.4.6 Slave Security Request

Definition at line 1789 of file SMPTypes.hpp.

Constructor & Destructor Documentation

SMPSecurityReqMsg() [1/2]

direct_bt::SMPSecurityReqMsg::SMPSecurityReqMsg ( const uint8_t *  source, const jau::nsize_t  length  )

inline

Definition at line 1794 of file SMPTypes.hpp.

Here is the call graph for this function:

SMPSecurityReqMsg() [2/2]

direct_bt::SMPSecurityReqMsg::SMPSecurityReqMsg ( const SMPAuthReqs  auth_req_mask )

inline

Definition at line 1801 of file SMPTypes.hpp.

Here is the call graph for this function:

Member Function Documentation

getAuthReqMask()

constexpr SMPAuthReqs direct_bt::SMPSecurityReqMsg::getAuthReqMask ( ) const

inlineconstexprnoexcept

Returns the SMPPairingMsg::AuthRequirements (1 octet)

The AuthReq field is a bit field that indicates the requested security properties,
see Vol 3 (Host), Part H (SM): 2 (SM), 2.3 Pairing Methods, 2.3.1 Security Properties,
for the STK or LTK and GAP bonding information,
see Vol 3 (Host), Part C (GAP): 9.4 Bonding Modes and Procedures

Definition at line 1820 of file SMPTypes.hpp.

Here is the caller graph for this function:

getDataSize()

constexpr_cxx20 jau::nsize_t direct_bt::SMPSecurityReqMsg::getDataSize ( ) const

inlineoverridevirtualnoexcept

Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets.

See also

SMPPDUMsg::getPDUParamSize()

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1807 of file SMPTypes.hpp.

getName()

constexpr_cxx20 std::string direct_bt::SMPSecurityReqMsg::getName ( ) const

inlineoverridevirtualnoexcept

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1827 of file SMPTypes.hpp.

isAuthRequirementBitSet()

constexpr bool direct_bt::SMPSecurityReqMsg::isAuthRequirementBitSet ( const SMPAuthReqs  bit ) const

inlineconstexprnoexcept

Definition at line 1823 of file SMPTypes.hpp.

Here is the call graph for this function:

valueString()

std::string direct_bt::SMPSecurityReqMsg::valueString ( ) const

inlineoverrideprotectedvirtualnoexcept

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1832 of file SMPTypes.hpp.

Here is the call graph for this function:

---

The documentation for this class was generated from the following file:

• /usr/local/projects/direct_bt/api/direct_bt/SMPTypes.hpp