// Copyright (C) 2024, Mark Qvist // This program is free software: you can redistribute it and/or modify // it under the terms of the GNU General Public License as published by // the Free Software Foundation, either version 3 of the License, or // (at your option) any later version. // This program is distributed in the hope that it will be useful, // but WITHOUT ANY WARRANTY; without even the implied warranty of // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the // GNU General Public License for more details. // You should have received a copy of the GNU General Public License // along with this program. If not, see . #if MCU_VARIANT == MCU_ESP32 #if HAS_BLUETOOTH == true #include "BluetoothSerial.h" #include "esp_bt_main.h" #include "esp_bt_device.h" BluetoothSerial SerialBT; #elif HAS_BLE == true #include "esp_bt_main.h" #include "esp_bt_device.h" #include "src/ble/BLESerial.h" BLESerial SerialBT; #endif #elif MCU_VARIANT == MCU_NRF52 #include #include #define BLE_MTU 512+3 BLEUart SerialBT(BLE_MTU); BLEDis bledis; BLEBas blebas; bool SerialBT_init = false; extern void led_indicate_info(int); #endif #define BT_PAIRING_TIMEOUT 35000 #define BLE_FLUSH_TIMEOUT 20 uint32_t bt_pairing_started = 0; #define BT_DEV_ADDR_LEN 6 #define BT_DEV_HASH_LEN 16 uint8_t dev_bt_mac[BT_DEV_ADDR_LEN]; char bt_da[BT_DEV_ADDR_LEN]; char bt_dh[BT_DEV_HASH_LEN]; char bt_devname[11]; #if MCU_VARIANT == MCU_ESP32 #if HAS_BLUETOOTH == true void bt_confirm_pairing(uint32_t numVal) { bt_ssp_pin = numVal; kiss_indicate_btpin(); if (bt_allow_pairing) { SerialBT.confirmReply(true); } else { SerialBT.confirmReply(false); } } void bt_stop() { //display_unblank(); if (bt_state != BT_STATE_OFF) { SerialBT.end(); bt_allow_pairing = false; bt_state = BT_STATE_OFF; } } void bt_start() { //display_unblank(); if (bt_state == BT_STATE_OFF) { SerialBT.begin(bt_devname); bt_state = BT_STATE_ON; } } void bt_enable_pairing() { //display_unblank(); if (bt_state == BT_STATE_OFF) bt_start(); bt_allow_pairing = true; bt_pairing_started = millis(); bt_state = BT_STATE_PAIRING; } void bt_disable_pairing() { //display_unblank(); bt_allow_pairing = false; bt_ssp_pin = 0; bt_state = BT_STATE_ON; } void bt_pairing_complete(boolean success) { //display_unblank(); if (success) { bt_disable_pairing(); } else { bt_ssp_pin = 0; } } void bt_connection_callback(esp_spp_cb_event_t event, esp_spp_cb_param_t *param) { //display_unblank(); if(event == ESP_SPP_SRV_OPEN_EVT) { bt_state = BT_STATE_CONNECTED; cable_state = CABLE_STATE_DISCONNECTED; } if(event == ESP_SPP_CLOSE_EVT ){ bt_state = BT_STATE_ON; } } bool bt_setup_hw() { if (!bt_ready) { if (EEPROM.read(eeprom_addr(ADDR_CONF_BT)) == BT_ENABLE_BYTE) { bt_enabled = true; } else { bt_enabled = false; } if (btStart()) { if (esp_bluedroid_init() == ESP_OK) { if (esp_bluedroid_enable() == ESP_OK) { const uint8_t* bda_ptr = esp_bt_dev_get_address(); char *data = (char*)malloc(BT_DEV_ADDR_LEN+1); for (int i = 0; i < BT_DEV_ADDR_LEN; i++) { data[i] = bda_ptr[i]; } data[BT_DEV_ADDR_LEN] = EEPROM.read(eeprom_addr(ADDR_SIGNATURE)); unsigned char *hash = MD5::make_hash(data, BT_DEV_ADDR_LEN); memcpy(bt_dh, hash, BT_DEV_HASH_LEN); sprintf(bt_devname, "RNode %02X%02X", bt_dh[14], bt_dh[15]); free(data); SerialBT.enableSSP(); SerialBT.onConfirmRequest(bt_confirm_pairing); SerialBT.onAuthComplete(bt_pairing_complete); SerialBT.register_callback(bt_connection_callback); bt_ready = true; return true; } else { return false; } } else { return false; } } else { return false; } } else { return false; } } bool bt_init() { bt_state = BT_STATE_OFF; if (bt_setup_hw()) { if (bt_enabled && !console_active) bt_start(); return true; } else { return false; } } void update_bt() { if (bt_allow_pairing && millis()-bt_pairing_started >= BT_PAIRING_TIMEOUT) { bt_disable_pairing(); } } #elif HAS_BLE == true BLESecurity *ble_security = new BLESecurity(); bool ble_authenticated = false; uint32_t pairing_pin = 0; void bt_flush() { if (bt_state == BT_STATE_CONNECTED) { SerialBT.flush(); } } void bt_disable_pairing() { //display_unblank(); bt_allow_pairing = false; bt_ssp_pin = 0; bt_state = BT_STATE_ON; } void bt_passkey_notify_callback(uint32_t passkey) { // Serial.printf("Got passkey notification: %d\n", passkey); bt_ssp_pin = passkey; bt_state = BT_STATE_PAIRING; bt_allow_pairing = true; bt_pairing_started = millis(); kiss_indicate_btpin(); } bool bt_confirm_pin_callback(uint32_t pin) { // Serial.printf("Confirm PIN callback: %d\n", pin); return true; } void bt_debond_all() { // Serial.println("Debonding all"); int dev_num = esp_ble_get_bond_device_num(); esp_ble_bond_dev_t *dev_list = (esp_ble_bond_dev_t *)malloc(sizeof(esp_ble_bond_dev_t) * dev_num); esp_ble_get_bond_device_list(&dev_num, dev_list); for (int i = 0; i < dev_num; i++) { esp_ble_remove_bond_device(dev_list[i].bd_addr); } free(dev_list); } void bt_update_passkey() { // Serial.println("Updating passkey"); pairing_pin = random(899999)+100000; bt_ssp_pin = pairing_pin; } uint32_t bt_passkey_callback() { // Serial.println("API passkey request"); if (pairing_pin == 0) { bt_update_passkey(); } return pairing_pin; } bool bt_client_authenticated() { return ble_authenticated; } void bt_security_setup() { uint32_t passkey = bt_passkey_callback(); // Serial.printf("Executing BT security setup, passkey is %d\n", passkey); uint8_t key_size = 16; uint8_t init_key = ESP_BLE_ENC_KEY_MASK | ESP_BLE_ID_KEY_MASK; uint8_t rsp_key = ESP_BLE_ENC_KEY_MASK | ESP_BLE_ID_KEY_MASK; esp_ble_auth_req_t auth_req = ESP_LE_AUTH_REQ_SC_MITM_BOND; uint8_t auth_option = ESP_BLE_ONLY_ACCEPT_SPECIFIED_AUTH_ENABLE; uint8_t oob_support = ESP_BLE_OOB_DISABLE; esp_ble_io_cap_t iocap = ESP_IO_CAP_OUT; esp_ble_gap_set_security_param(ESP_BLE_SM_SET_STATIC_PASSKEY, &passkey, sizeof(uint32_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_AUTHEN_REQ_MODE, &auth_req, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_IOCAP_MODE, &iocap, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_MAX_KEY_SIZE, &key_size, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_ONLY_ACCEPT_SPECIFIED_SEC_AUTH, &auth_option, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_OOB_SUPPORT, &oob_support, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_SET_INIT_KEY, &init_key, sizeof(uint8_t)); esp_ble_gap_set_security_param(ESP_BLE_SM_SET_RSP_KEY, &rsp_key, sizeof(uint8_t)); } bool bt_security_request_callback() { if (bt_allow_pairing) { // Serial.println("Accepting security request"); return true; } else { // Serial.println("Rejecting security request"); return false; } } void bt_authentication_complete_callback(esp_ble_auth_cmpl_t auth_result) { if (auth_result.success == true) { // Serial.println("Authentication success"); ble_authenticated = true; bt_state = BT_STATE_CONNECTED; } else { // Serial.println("Authentication fail"); ble_authenticated = false; bt_state = BT_STATE_ON; bt_security_setup(); } bt_allow_pairing = false; bt_ssp_pin = 0; } void bt_connect_callback(BLEServer *server) { // uint16_t conn_id = server->getConnId(); // Serial.printf("Connected: %d\n", conn_id); //display_unblank(); ble_authenticated = false; bt_state = BT_STATE_CONNECTED; cable_state = CABLE_STATE_DISCONNECTED; } void bt_disconnect_callback(BLEServer *server) { // uint16_t conn_id = server->getConnId(); // Serial.printf("Disconnected: %d\n", conn_id); //display_unblank(); ble_authenticated = false; bt_state = BT_STATE_ON; } bool bt_setup_hw() { if (!bt_ready) { if (EEPROM.read(eeprom_addr(ADDR_CONF_BT)) == BT_ENABLE_BYTE) { bt_enabled = true; } else { bt_enabled = false; } if (btStart()) { if (esp_bluedroid_init() == ESP_OK) { if (esp_bluedroid_enable() == ESP_OK) { const uint8_t* bda_ptr = esp_bt_dev_get_address(); char *data = (char*)malloc(BT_DEV_ADDR_LEN+1); for (int i = 0; i < BT_DEV_ADDR_LEN; i++) { data[i] = bda_ptr[i]; } data[BT_DEV_ADDR_LEN] = EEPROM.read(eeprom_addr(ADDR_SIGNATURE)); unsigned char *hash = MD5::make_hash(data, BT_DEV_ADDR_LEN); memcpy(bt_dh, hash, BT_DEV_HASH_LEN); sprintf(bt_devname, "RNode %02X%02X", bt_dh[14], bt_dh[15]); free(data); bt_security_setup(); bt_ready = true; return true; } else { return false; } } else { return false; } } else { return false; } } else { return false; } } void bt_start() { //display_unblank(); if (bt_state == BT_STATE_OFF) { bt_state = BT_STATE_ON; SerialBT.begin(bt_devname); SerialBT.setTimeout(10); } } void bt_stop() { //display_unblank(); if (bt_state != BT_STATE_OFF) { bt_allow_pairing = false; bt_state = BT_STATE_OFF; SerialBT.end(); } } bool bt_init() { bt_state = BT_STATE_OFF; if (bt_setup_hw()) { if (bt_enabled && !console_active) bt_start(); return true; } else { return false; } } void bt_enable_pairing() { //display_unblank(); if (bt_state == BT_STATE_OFF) bt_start(); bt_security_setup(); //bt_debond_all(); //bt_update_passkey(); bt_allow_pairing = true; bt_pairing_started = millis(); bt_state = BT_STATE_PAIRING; } void update_bt() { if (bt_allow_pairing && millis()-bt_pairing_started >= BT_PAIRING_TIMEOUT) { bt_disable_pairing(); } if (bt_state == BT_STATE_CONNECTED && millis()-SerialBT.lastFlushTime >= BLE_FLUSH_TIMEOUT) { if (SerialBT.transmitBufferLength > 0) { bt_flush(); } } } #endif #elif MCU_VARIANT == MCU_NRF52 uint8_t eeprom_read(uint32_t mapped_addr); void bt_bond_wipe() { // Delete all bonding data Bluefruit.Periph.clearBonds(); led_indicate_info(2); } void bt_stop() { if (bt_state != BT_STATE_OFF) { bt_allow_pairing = false; bt_state = BT_STATE_OFF; } } void bt_disable_pairing() { bt_allow_pairing = false; bt_ssp_pin = 0; bt_state = BT_STATE_ON; } void bt_pairing_complete(uint16_t conn_handle, uint8_t auth_status) { if (auth_status == BLE_GAP_SEC_STATUS_SUCCESS) { BLEConnection* connection = Bluefruit.Connection(conn_handle); ble_gap_conn_sec_mode_t security = connection->getSecureMode(); // On the NRF52 it is not possible with the Arduino library to reject // requests from devices with no IO capabilities, which would allow // bypassing pin entry through pairing using the "just works" mode. // Therefore, we must check the security level of the connection after // pairing to ensure "just works" has not been used. If it has, we need // to disconnect, unpair and delete any bonding information immediately. // Settings on the SerialBT service should prevent unauthorised access to // the serial port anyway, but this is still wise to do regardless. // // Note: It may be nice to have this done in the BLESecurity class in the // future, but as it stands right now I'd have to fork the BSP to do // that, which I don't fancy doing. Impact on security is likely minimal. // Requires investigation. if (security.sm == 1 && security.lv >= 3) { bt_state = BT_STATE_CONNECTED; cable_state = CABLE_STATE_DISCONNECTED; bt_disable_pairing(); } else { if (connection->bonded()) { connection->removeBondKey(); } connection->disconnect(); } } else { bt_ssp_pin = 0; } } bool bt_passkey_callback(uint16_t conn_handle, uint8_t const passkey[6], bool match_request) { for (int i = 0; i < 6; i++) { // multiply by tens however many times needed to make numbers appear in order bt_ssp_pin += ((int)passkey[i] - 48) * pow(10, 5-i); } kiss_indicate_btpin(); if (bt_allow_pairing) { return true; } return false; } void bt_connect_callback(uint16_t conn_handle) { bt_state = BT_STATE_CONNECTED; cable_state = CABLE_STATE_DISCONNECTED; BLEConnection* conn = Bluefruit.Connection(conn_handle); conn->requestPHY(BLE_GAP_PHY_2MBPS); conn->requestMtuExchange(BLE_MTU); conn->requestDataLengthUpdate(); } void bt_disconnect_callback(uint16_t conn_handle, uint8_t reason) { if (reason != BLE_GAP_SEC_STATUS_SUCCESS) { bt_state = BT_STATE_ON; } } bool bt_setup_hw() { if (!bt_ready) { #if HAS_EEPROM if (EEPROM.read(eeprom_addr(ADDR_CONF_BT)) == BT_ENABLE_BYTE) { #else if (eeprom_read(eeprom_addr(ADDR_CONF_BT)) == BT_ENABLE_BYTE) { #endif bt_enabled = true; } else { bt_enabled = false; } Bluefruit.configPrphBandwidth(BANDWIDTH_MAX); Bluefruit.autoConnLed(false); if (Bluefruit.begin()) { Bluefruit.setTxPower(8); // Check bluefruit.h for supported values Bluefruit.Security.setIOCaps(true, false, false); // display, yes; yes / no, no; keyboard, no // This device is indeed capable of yes / no through the pairing mode // being set, but I have chosen to set it thus to force the input of the // pin on the device initiating the pairing. Bluefruit.Security.setMITM(true); Bluefruit.Security.setPairPasskeyCallback(bt_passkey_callback); Bluefruit.Security.setSecuredCallback(bt_connect_callback); Bluefruit.Periph.setDisconnectCallback(bt_disconnect_callback); Bluefruit.Security.setPairCompleteCallback(bt_pairing_complete); Bluefruit.Periph.setConnInterval(6, 12); // 7.5 - 15 ms const ble_gap_addr_t gap_addr = Bluefruit.getAddr(); char *data = (char*)malloc(BT_DEV_ADDR_LEN+1); for (int i = 0; i < BT_DEV_ADDR_LEN; i++) { data[i] = gap_addr.addr[i]; } #if HAS_EEPROM data[BT_DEV_ADDR_LEN] = EEPROM.read(eeprom_addr(ADDR_SIGNATURE)); #else data[BT_DEV_ADDR_LEN] = eeprom_read(eeprom_addr(ADDR_SIGNATURE)); #endif unsigned char *hash = MD5::make_hash(data, BT_DEV_ADDR_LEN); memcpy(bt_dh, hash, BT_DEV_HASH_LEN); sprintf(bt_devname, "openCom XL %02X%02X", bt_dh[14], bt_dh[15]); free(data); bt_ready = true; return true; } else { return false; } } else { return false; } } void bt_start() { if (bt_state == BT_STATE_OFF) { Bluefruit.setName(bt_devname); bledis.setManufacturer(BLE_MANUFACTURER); bledis.setModel(BLE_MODEL); // start device information service bledis.begin(); // Guard to ensure SerialBT service is not duplicated through BT being power cycled if (!SerialBT_init) { SerialBT.bufferTXD(true); // enable buffering SerialBT.setPermission(SECMODE_ENC_WITH_MITM, SECMODE_ENC_WITH_MITM); // enable encryption for BLE serial SerialBT.begin(); SerialBT_init = true; } blebas.begin(); Bluefruit.Advertising.addFlags(BLE_GAP_ADV_FLAGS_LE_ONLY_GENERAL_DISC_MODE); Bluefruit.Advertising.addTxPower(); // Include bleuart 128-bit uuid Bluefruit.Advertising.addService(SerialBT); // There is no room for Name in Advertising packet // Use Scan response for Name Bluefruit.ScanResponse.addName(); Bluefruit.Advertising.start(0); bt_state = BT_STATE_ON; } } bool bt_init() { bt_state = BT_STATE_OFF; if (bt_setup_hw()) { if (bt_enabled && !console_active) bt_start(); return true; } else { return false; } } void bt_enable_pairing() { if (bt_state == BT_STATE_OFF) bt_start(); bt_allow_pairing = true; bt_pairing_started = millis(); bt_state = BT_STATE_PAIRING; } void update_bt() { if (bt_allow_pairing && millis()-bt_pairing_started >= BT_PAIRING_TIMEOUT) { bt_disable_pairing(); } } #endif