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

Vol 3, Part H: 3.5.1 Pairing Request message. More...

#include <SMPTypes.hpp>

Inheritance diagram for direct_bt::SMPPairingMsg:
Collaboration diagram for direct_bt::SMPPairingMsg:

Public Member Functions

 SMPPairingMsg (const bool request_, const SMPIOCapability ioc, const SMPOOBDataFlag odf, const SMPAuthReqs auth_req_mask, const uint8_t maxEncKeySize, const SMPKeyType initiator_key_dist_, const SMPKeyType responder_key_dist_)
 
 SMPPairingMsg (const bool request_, const uint8_t *source, const jau::nsize_t length)
 
constexpr SMPAuthReqs getAuthReqMask () const noexcept
 Returns the Authentication Requirements mask. 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...
 
constexpr SMPKeyType getInitKeyDist () const noexcept
 Returns the Initiator Key Distribution field, which defines which keys the initiator shall distribute and use during the Transport Specific Key Distribution phase. More...
 
constexpr SMPIOCapability getIOCapability () const noexcept
 Returns the IO capability bit field. More...
 
constexpr uint8_t getMaxEncryptionKeySize () const noexcept
 This value defines the maximum encryption key size in octets that the device can support. More...
 
std::string getName () const noexcept override
 
constexpr SMPOOBDataFlag getOOBDataFlag () const noexcept
 Returns the OBB authenticate data flag. More...
 
constexpr SMPKeyType getRespKeyDist () const noexcept
 Return the Responder Key Distribution field, which defines which keys the responder shall distribute and use during the Transport Specific Key Distribution phase. More...
 
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.5.1 Pairing Request message.


Vol 3, Part H: 3.5.2 Pairing Response message.

Vol 3 (Host), Part H (SM): 3 (SMP), 3.5 Pairing Methods
Vol 3 (Host), Part H (SM): 2 (SM), 2.3 Pairing Methods

Opcode::PAIRING_REQUEST or Opcode::PAIRING_RESPONSE

[uint8_t opcode]
uint8_t io_capability
uint8_t oob_data_flag
uint8_t auth_req_mask
uint8_t max_encryption_key_size
uint8_t initiator_key_distribution
uint8_t responder_key_distribution


SMP Pairing Request Vol 3, Part H (SM): 3.5.1

Initiator starts the Pairing Feature Exchange by sending a Pairing Request command to the responding device.

The rules for handing a collision between a pairing procedure on the LE transport and a pairing procedure on the BR/EDR transport are defined in Vol 3, Part C (GAP): 14.2 BRD/EDR/LE security aspects - Collision Handling.


SMP Pairing Response Vol 3, Part H (SM): 3.5.2

Command is used by the responding device to complete the Pairing Feature Exchange after it has received a Pairing Request command from the initiating device, if the responding device allows pairing.

If a Pairing Request is received over the BR/EDR transport when either cross-transport key derivation/generation is not supported or the BR/EDR transport is not encrypted using a Link Key generated using P256, a Pairing Failed shall be sent with the error code SMPPairFailedMsg::ReasonCode::CROSSXPORT_KEY_DERIGEN_NOT_ALLOWED (Cross-Transport Key Derivation/Generation Not Allowed).

The rules for handing a collision between a pairing procedure on the LE transport and a pairing procedure on the BR/EDR transport are defined in Vol 3, Part C (GAP): 14.2 BRD/EDR/LE security aspects - Collision Handling.

Definition at line 1084 of file SMPTypes.hpp.

Constructor & Destructor Documentation

◆ SMPPairingMsg() [1/2]

direct_bt::SMPPairingMsg::SMPPairingMsg ( const bool  request_,
const uint8_t *  source,
const jau::nsize_t  length 
)
inline

Definition at line 1093 of file SMPTypes.hpp.

◆ SMPPairingMsg() [2/2]

direct_bt::SMPPairingMsg::SMPPairingMsg ( const bool  request_,
const SMPIOCapability  ioc,
const SMPOOBDataFlag  odf,
const SMPAuthReqs  auth_req_mask,
const uint8_t  maxEncKeySize,
const SMPKeyType  initiator_key_dist_,
const SMPKeyType  responder_key_dist_ 
)
inline

Definition at line 1104 of file SMPTypes.hpp.

Member Function Documentation

◆ getDataSize()

constexpr_cxx20 jau::nsize_t direct_bt::SMPPairingMsg::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 1122 of file SMPTypes.hpp.

◆ getIOCapability()

constexpr SMPIOCapability direct_bt::SMPPairingMsg::getIOCapability ( ) const
inlineconstexprnoexcept

Returns the IO capability bit field.

Vol 3, Part H, 2.3.2 IO capabilities
See also
IOCapability

Definition at line 1133 of file SMPTypes.hpp.

◆ getOOBDataFlag()

constexpr SMPOOBDataFlag direct_bt::SMPPairingMsg::getOOBDataFlag ( ) const
inlineconstexprnoexcept

Returns the OBB authenticate data flag.

Vol 3, Part H, 2.3.3 OOB authentication data
See also
OOBDataFlag

Definition at line 1144 of file SMPTypes.hpp.

◆ getAuthReqMask()

constexpr SMPAuthReqs direct_bt::SMPPairingMsg::getAuthReqMask ( ) const
inlineconstexprnoexcept

Returns the Authentication Requirements mask.

SMP Pairing Request Vol 3, Part H (SM): 3.5.1
SMP Pairing Response Vol 3, Part H (SM): 3.5.2
See also
AuthRequirements

Definition at line 1156 of file SMPTypes.hpp.

◆ isAuthRequirementBitSet()

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

Definition at line 1159 of file SMPTypes.hpp.

◆ getMaxEncryptionKeySize()

constexpr uint8_t direct_bt::SMPPairingMsg::getMaxEncryptionKeySize ( ) const
inlineconstexprnoexcept

This value defines the maximum encryption key size in octets that the device can support.

The maximum key size shall be in the range 7 to 16 octets.

Definition at line 1167 of file SMPTypes.hpp.

◆ getInitKeyDist()

constexpr SMPKeyType direct_bt::SMPPairingMsg::getInitKeyDist ( ) const
inlineconstexprnoexcept

Returns the Initiator Key Distribution field, which defines which keys the initiator shall distribute and use during the Transport Specific Key Distribution phase.

See Vol 3, Part H, 2.4.3 SM - LE Security - Distribution of keys.
Field format and usage: Vol 3, Part H, 3.6.1 SMP - LE Security - Key distribution and generation.
See also
SMPKeyDistFormat

Definition at line 1180 of file SMPTypes.hpp.

◆ getRespKeyDist()

constexpr SMPKeyType direct_bt::SMPPairingMsg::getRespKeyDist ( ) const
inlineconstexprnoexcept

Return the Responder Key Distribution field, which defines which keys the responder shall distribute and use during the Transport Specific Key Distribution phase.

See Vol 3, Part H, 2.4.3 SM - LE Security - Distribution of keys. Field format and usage: Vol 3, Part H, 3.6.1 SMP - LE Security - Key distribution and generation.

See also
SMPKeyDistFormat

Definition at line 1193 of file SMPTypes.hpp.

◆ getName()

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

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1197 of file SMPTypes.hpp.

◆ valueString()

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

Reimplemented from direct_bt::SMPPDUMsg.

Definition at line 1202 of file SMPTypes.hpp.


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