Direct-BT v3.3.0-1-gc2d430c
Direct-BT - Direct Bluetooth Programming.
Public Member Functions | Protected Member Functions | List of all members
direct_bt::SMPSecurityReqMsg Class Referencefinal

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 SMPAuthReqs auth_req_mask)
 
 SMPSecurityReqMsg (const uint8_t *source, const jau::nsize_t length)
 
constexpr SMPAuthReqs getAuthReqMask () const noexcept
 Returns the SMPPairingMsg::AuthRequirements (1 octet) More...
 
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...
 
std::string getName () const noexcept override
 
constexpr bool isAuthRequirementBitSet (const SMPAuthReqs bit) const noexcept
 
- Public Member Functions inherited from direct_bt::SMPPDUMsg
 SMPPDUMsg (const Opcode opc, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
 SMPPDUMsg (const uint8_t *source, const jau::nsize_t size)
 Persistent memory, w/ ownership . More...
 
 SMPPDUMsg (const uint8_t *source, const jau::nsize_t size, const jau::nsize_t min_size)
 Persistent memory, w/ ownership . More...
 
virtual ~SMPPDUMsg () noexcept=default
 
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 constexpr_cxx20 jau::nsize_t getDataSize () const noexcept
 Returns the required data size according to the specified packet, which should be within 0-22 or 64 octets. More...
 
virtual std::string getName () 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 uint64_t getTimestamp () const noexcept
 
virtual std::string toString () const noexcept
 

Protected Member Functions

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

Additional Inherited Members

- Public Types inherited from direct_bt::SMPPDUMsg
enum class  Opcode : uint8_t {
  UNDEFINED = 0x00 , PAIRING_REQUEST = 0x01 , PAIRING_RESPONSE = 0x02 , PAIRING_CONFIRM = 0x03 ,
  PAIRING_RANDOM = 0x04 , PAIRING_FAILED = 0x05 , ENCRYPTION_INFORMATION = 0x06 , MASTER_IDENTIFICATION = 0x07 ,
  IDENTITY_INFORMATION = 0x08 , IDENTITY_ADDRESS_INFORMATION = 0x09 , SIGNING_INFORMATION = 0x0A , SECURITY_REQUEST = 0x0B ,
  PAIRING_PUBLIC_KEY = 0x0C , PAIRING_DHKEY_CHECK = 0x0D , PAIRING_KEYPRESS_NOTIFICATION = 0x0E
}
 SMP Command Codes Vol 3, Part H (SM): 3.3. More...
 
- Static Public Member Functions inherited from direct_bt::SMPPDUMsg
template<class T >
static T * clone (const T &source) noexcept
 Clone template for convenience, based on derived class's copy-constructor. More...
 
static std::string getOpcodeString (const Opcode opc) noexcept
 
static std::unique_ptr< const SMPPDUMsggetSpecialized (const uint8_t *buffer, jau::nsize_t const buffer_size) noexcept
 Return a newly created specialized instance pointer to base class. More...
 
static constexpr uint8_t number (const Opcode rhs) noexcept
 
- Protected Attributes inherited from direct_bt::SMPPDUMsg
jau::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 2026 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 2031 of file SMPTypes.hpp.

◆ SMPSecurityReqMsg() [2/2]

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

Definition at line 2039 of file SMPTypes.hpp.

Member Function Documentation

◆ 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 2046 of file SMPTypes.hpp.

◆ 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 2059 of file SMPTypes.hpp.

◆ isAuthRequirementBitSet()

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

Definition at line 2062 of file SMPTypes.hpp.

◆ getName()

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

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 2066 of file SMPTypes.hpp.

◆ valueString()

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

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 2071 of file SMPTypes.hpp.


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