esp32-nimble 0.12.0

A wrapper for the ESP32 NimBLE Bluetooth stack.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67

use crate::enums;
use esp_idf_svc::sys as esp_idf_sys;

pub struct BLESecurity {
    passkey: u32,
}

impl BLESecurity {
    pub(crate) fn new() -> Self {
        Self { passkey: 0 }
    }

    /// Set the authorization mode for this device.
    pub fn set_auth(&mut self, auth_req: enums::AuthReq) -> &mut Self {
        unsafe {
            esp_idf_sys::ble_hs_cfg.set_sm_bonding(auth_req.contains(enums::AuthReq::Bond).into());
            esp_idf_sys::ble_hs_cfg.set_sm_mitm(auth_req.contains(enums::AuthReq::Mitm).into());
            esp_idf_sys::ble_hs_cfg.set_sm_sc(auth_req.contains(enums::AuthReq::Sc).into());
        }

        self
    }

    /// Get the current passkey used for pairing.
    pub fn get_passkey(&self) -> u32 {
        self.passkey
    }

    /// Set the passkey the server will ask for when pairing.
    /// * The passkey will always be exactly 6 digits. Setting the passkey to 1234
    ///   will require the user to provide '001234'
    /// * a dynamic passkey can also be set by [`crate::BLEServer::on_passkey_request`]
    pub fn set_passkey(&mut self, passkey: u32) -> &mut Self {
        debug_assert!(
            passkey <= 999999,
            "passkey must be between 000000..=999999 inclusive"
        );
        self.passkey = passkey;
        self
    }

    /// Set the Input/Output capabilities of this device.
    pub fn set_io_cap(&mut self, iocap: enums::SecurityIOCap) -> &mut Self {
        unsafe { esp_idf_sys::ble_hs_cfg.sm_io_cap = iocap.into() };
        self
    }

    /// If we are the initiator of the security procedure this sets the keys we will distribute.
    pub fn set_security_init_key(&mut self, init_key: enums::PairKeyDist) -> &mut Self {
        unsafe { esp_idf_sys::ble_hs_cfg.sm_our_key_dist = init_key.bits() };
        self
    }

    /// Set the keys we are willing to accept during pairing.
    pub fn set_security_resp_key(&mut self, resp_key: enums::PairKeyDist) -> &mut Self {
        unsafe { esp_idf_sys::ble_hs_cfg.sm_their_key_dist = resp_key.bits() };
        self
    }

    /// Set up for pairing in RPA(Resolvable Private Address).
    ///
    /// ( see: <https://github.com/taks/esp32-nimble/issues/24> )
    pub fn resolve_rpa(&mut self) -> &mut Self {
        self.set_security_init_key(enums::PairKeyDist::ENC | enums::PairKeyDist::ID)
            .set_security_resp_key(enums::PairKeyDist::ENC | enums::PairKeyDist::ID)
    }
}