1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #define BTSTACK_FILE__ "sm_pairing_central.c" 39 40 41 // ***************************************************************************** 42 /* EXAMPLE_START(sm_pairing_central): LE Central - Test Pairing Methods 43 * 44 * @text Depending on the Authentication requiremens and IO Capabilities, 45 * the pairing process uses different short and long term key generation method. 46 * This example helps explore the different options incl. LE Secure Connections. 47 * It scans for advertisements and connects to the first device that lists a 48 * random service. 49 */ 50 // ***************************************************************************** 51 52 53 #include <stdint.h> 54 #include <inttypes.h> 55 #include <stdio.h> 56 #include <stdlib.h> 57 #include <string.h> 58 59 #include "btstack.h" 60 // sm_pairing_central.gatt contains the declaration of the provided GATT Services + Characteristics 61 // sm_pairing_central.h contains the binary representation of sm_pairing_central.gatt 62 // it is generated by the build system by calling: $BTSTACK_ROOT/tool/compile_gatt.py sm_pairing_central.gatt sm_pairing_central.h 63 // it needs to be regenerated when the GATT Database declared in sm_pairing_central.gatt file is modified 64 #include "sm_pairing_central.h" 65 66 67 // We're looking for a remote device that lists this service in the advertisement 68 // LightBlue assigns 0x1111 as the UUID for a Blank service. 69 #define REMOTE_SERVICE 0x1111 70 71 // Fixed passkey - used with sm_pairing_peripheral. Passkey is random in general 72 #define FIXED_PASSKEY 123456U 73 74 75 static btstack_packet_callback_registration_t hci_event_callback_registration; 76 static btstack_packet_callback_registration_t sm_event_callback_registration; 77 78 /* @section GAP LE setup for receiving advertisements 79 * 80 * @text GAP LE advertisements are received as custom HCI events of the 81 * GAP_EVENT_ADVERTISING_REPORT type. To receive them, you'll need to register 82 * the HCI packet handler, as shown in Listing GAPLEAdvSetup. 83 */ 84 85 /* LISTING_START(GAPLEAdvSetup): Setting up GAP LE client for receiving advertisements */ 86 static void hci_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 87 static void sm_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 88 89 static void sm_pairing_central_setup(void){ 90 l2cap_init(); 91 92 // setup le device db 93 le_device_db_init(); 94 95 // setup SM: Display only 96 sm_init(); 97 98 // setup ATT server 99 att_server_init(profile_data, NULL, NULL); 100 101 // setup GATT Client 102 gatt_client_init(); 103 104 // register handler 105 hci_event_callback_registration.callback = &hci_packet_handler; 106 hci_add_event_handler(&hci_event_callback_registration); 107 108 sm_event_callback_registration.callback = &sm_packet_handler; 109 sm_add_event_handler(&sm_event_callback_registration); 110 111 112 // Configuration 113 114 // Enable mandatory authentication for GATT Client 115 // - if un-encrypted connections are not supported, e.g. when connecting to own device, this enforces authentication 116 // gatt_client_set_required_security_level(LEVEL_2); 117 118 /** 119 * Choose ONE of the following configurations 120 * Bonding is disabled to allow for repeated testing. It can be enabled by or'ing 121 * SM_AUTHREQ_BONDING to the authentication requirements like this: 122 * sm_set_authentication_requirements( X | SM_AUTHREQ_BONDING) 123 */ 124 125 // LE Legacy Pairing, Just Works 126 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 127 // sm_set_authentication_requirements(0); 128 129 // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays 130 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 131 // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION); 132 // sm_use_fixed_passkey_in_display_role(FIXED_PASSKEY); 133 134 #ifdef ENABLE_LE_SECURE_CONNECTIONS 135 136 // enable LE Secure Connections Only mode - disables Legacy pairing 137 // sm_set_secure_connections_only_mode(true); 138 139 // LE Secure Connections, Just Works 140 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 141 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION); 142 143 // LE Secure Connections, Numeric Comparison 144 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 145 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 146 147 // LE Secure Pairing, Passkey entry initiator (us) enters, responder displays 148 // sm_set_io_capabilities(IO_CAPABILITY_KEYBOARD_ONLY); 149 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 150 // sm_use_fixed_passkey_in_display_role(FIXED_PASSKEY); 151 152 // LE Secure Pairing, Passkey entry initiator (us) displays, responder enters 153 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 154 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 155 #endif 156 } 157 158 /* LISTING_END */ 159 160 /* @section HCI packet handler 161 * 162 * @text The HCI packet handler has to start the scanning, 163 * and to handle received advertisements. Advertisements are received 164 * as HCI event packets of the GAP_EVENT_ADVERTISING_REPORT type, 165 * see Listing HCIPacketHandler. 166 */ 167 168 /* LISTING_START(HCIPacketHandler): Scanning and receiving advertisements */ 169 170 static void hci_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 171 UNUSED(channel); 172 UNUSED(size); 173 174 if (packet_type != HCI_EVENT_PACKET) return; 175 hci_con_handle_t con_handle; 176 uint8_t status; 177 178 switch (hci_event_packet_get_type(packet)) { 179 case BTSTACK_EVENT_STATE: 180 // BTstack activated, get started 181 if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){ 182 printf("Start scaning!\n"); 183 gap_set_scan_parameters(1,0x0030, 0x0030); 184 gap_start_scan(); 185 } 186 break; 187 case GAP_EVENT_ADVERTISING_REPORT:{ 188 bd_addr_t address; 189 gap_event_advertising_report_get_address(packet, address); 190 uint8_t address_type = gap_event_advertising_report_get_address_type(packet); 191 uint8_t length = gap_event_advertising_report_get_data_length(packet); 192 const uint8_t * data = gap_event_advertising_report_get_data(packet); 193 // printf("Advertisement event: addr-type %u, addr %s, data[%u] ", 194 // address_type, bd_addr_to_str(address), length); 195 // printf_hexdump(data, length); 196 if (!ad_data_contains_uuid16(length, (uint8_t *) data, REMOTE_SERVICE)) break; 197 printf("Found remote with UUID %04x, connecting...\n", REMOTE_SERVICE); 198 gap_stop_scan(); 199 gap_connect(address,address_type); 200 break; 201 } 202 case HCI_EVENT_LE_META: 203 // wait for connection complete 204 if (hci_event_le_meta_get_subevent_code(packet) != HCI_SUBEVENT_LE_CONNECTION_COMPLETE) break; 205 con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet); 206 printf("Connection complete\n"); 207 208 // for testing, choose one of the following actions 209 210 // manually start pairing 211 sm_request_pairing(con_handle); 212 213 // gatt client request to authenticated characteristic in sm_pairing_peripheral (short cut, uses hard-coded value handle) 214 // gatt_client_read_value_of_characteristic_using_value_handle(&hci_packet_handler, con_handle, 0x0009); 215 216 // general gatt client request to trigger mandatory authentication 217 // gatt_client_discover_primary_services(&hci_packet_handler, con_handle); 218 break; 219 case HCI_EVENT_ENCRYPTION_CHANGE: 220 con_handle = hci_event_encryption_change_get_connection_handle(packet); 221 printf("Connection encrypted: %u\n", hci_event_encryption_change_get_encryption_enabled(packet)); 222 break; 223 case GATT_EVENT_QUERY_COMPLETE: 224 status = gatt_event_query_complete_get_att_status(packet); 225 switch (status){ 226 case ATT_ERROR_INSUFFICIENT_ENCRYPTION: 227 printf("GATT Query result: Insufficient Encryption\n"); 228 break; 229 case ATT_ERROR_INSUFFICIENT_AUTHENTICATION: 230 printf("GATT Query result: Insufficient Authentication\n"); 231 break; 232 case ATT_ERROR_BONDING_INFORMATION_MISSING: 233 printf("GATT Query result: Bonding Information Missing\n"); 234 break; 235 case ATT_ERROR_SUCCESS: 236 printf("GATT Query result: OK\n"); 237 break; 238 default: 239 printf("GATT Query result: 0x%02x\n", gatt_event_query_complete_get_att_status(packet)); 240 break; 241 } 242 break; 243 default: 244 break; 245 } 246 } 247 248 /* @section HCI packet handler 249 * 250 * @text The SM packet handler receives Security Manager Events required for pairing. 251 * It also receives events generated during Identity Resolving 252 * see Listing SMPacketHandler. 253 */ 254 255 /* LISTING_START(SMPacketHandler): Scanning and receiving advertisements */ 256 257 static void sm_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 258 UNUSED(channel); 259 UNUSED(size); 260 261 if (packet_type != HCI_EVENT_PACKET) return; 262 263 bd_addr_t addr; 264 bd_addr_type_t addr_type; 265 266 switch (hci_event_packet_get_type(packet)) { 267 case SM_EVENT_JUST_WORKS_REQUEST: 268 printf("Just works requested\n"); 269 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 270 break; 271 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 272 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 273 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 274 break; 275 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 276 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 277 break; 278 case SM_EVENT_PASSKEY_INPUT_NUMBER: 279 printf("Passkey Input requested\n"); 280 printf("Sending fixed passkey %"PRIu32"\n", (uint32_t) FIXED_PASSKEY); 281 sm_passkey_input(sm_event_passkey_input_number_get_handle(packet), FIXED_PASSKEY); 282 break; 283 case SM_EVENT_PAIRING_STARTED: 284 printf("Pairing started\n"); 285 break; 286 case SM_EVENT_PAIRING_COMPLETE: 287 switch (sm_event_pairing_complete_get_status(packet)){ 288 case ERROR_CODE_SUCCESS: 289 printf("Pairing complete, success\n"); 290 break; 291 case ERROR_CODE_CONNECTION_TIMEOUT: 292 printf("Pairing failed, timeout\n"); 293 break; 294 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 295 printf("Pairing failed, disconnected\n"); 296 break; 297 case ERROR_CODE_AUTHENTICATION_FAILURE: 298 printf("Pairing failed, authentication failure with reason = %u\n", sm_event_pairing_complete_get_reason(packet)); 299 break; 300 default: 301 break; 302 } 303 break; 304 case SM_EVENT_REENCRYPTION_STARTED: 305 sm_event_reencryption_complete_get_address(packet, addr); 306 printf("Bonding information exists for addr type %u, identity addr %s -> start re-encryption\n", 307 sm_event_reencryption_started_get_addr_type(packet), bd_addr_to_str(addr)); 308 break; 309 case SM_EVENT_REENCRYPTION_COMPLETE: 310 switch (sm_event_reencryption_complete_get_status(packet)){ 311 case ERROR_CODE_SUCCESS: 312 printf("Re-encryption complete, success\n"); 313 break; 314 case ERROR_CODE_CONNECTION_TIMEOUT: 315 printf("Re-encryption failed, timeout\n"); 316 break; 317 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 318 printf("Re-encryption failed, disconnected\n"); 319 break; 320 case ERROR_CODE_PIN_OR_KEY_MISSING: 321 printf("Re-encryption failed, bonding information missing\n\n"); 322 printf("Assuming remote lost bonding information\n"); 323 printf("Deleting local bonding information and start new pairing...\n"); 324 sm_event_reencryption_complete_get_address(packet, addr); 325 addr_type = sm_event_reencryption_started_get_addr_type(packet); 326 gap_delete_bonding(addr_type, addr); 327 sm_request_pairing(sm_event_reencryption_complete_get_handle(packet)); 328 break; 329 default: 330 break; 331 } 332 break; 333 default: 334 break; 335 } 336 } 337 /* LISTING_END */ 338 339 int btstack_main(void); 340 int btstack_main(void) 341 { 342 sm_pairing_central_setup(); 343 344 // turn on! 345 hci_power_control(HCI_POWER_ON); 346 347 return 0; 348 } 349 350 /* EXAMPLE_END */ 351