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_peripheral.c" 39 40 // ***************************************************************************** 41 /* EXAMPLE_START(sm_pairing_peripheral): LE Peripheral - Test Pairing Methods 42 * 43 * @text Depending on the Authentication requiremens and IO Capabilities, 44 * the pairing process uses different short and long term key generation method. 45 * This example helps explore the different options incl. LE Secure Connections. 46 */ 47 // ***************************************************************************** 48 49 #include <stdint.h> 50 #include <stdio.h> 51 #include <stdlib.h> 52 #include <string.h> 53 #include <inttypes.h> 54 55 #include "sm_pairing_peripheral.h" 56 #include "btstack.h" 57 58 /* @section Main Application Setup 59 * 60 * @text Listing MainConfiguration shows main application code. 61 * It initializes L2CAP, the Security Manager and configures the ATT Server with the pre-compiled 62 * ATT Database generated from $sm_pairing_peripheral.gatt$. Finally, it configures the advertisements 63 * and boots the Bluetooth stack. 64 * In this example, the Advertisement contains the Flags attribute, the device name, and a 16-bit (test) service 0x1111 65 * The flag 0x06 indicates: LE General Discoverable Mode and BR/EDR not supported. 66 * Various examples for IO Capabilites and Authentication Requirements are given below. 67 */ 68 69 /* LISTING_START(MainConfiguration): Setup stack to advertise */ 70 static btstack_packet_callback_registration_t sm_event_callback_registration; 71 72 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size); 73 74 const uint8_t adv_data[] = { 75 // Flags general discoverable, BR/EDR not supported 76 0x02, BLUETOOTH_DATA_TYPE_FLAGS, 0x06, 77 // Name 78 0x0b, BLUETOOTH_DATA_TYPE_COMPLETE_LOCAL_NAME, 'S', 'M', ' ', 'P', 'a', 'i', 'r', 'i', 'n', 'g', 79 // Incomplete List of 16-bit Service Class UUIDs -- 1111 - only valid for testing! 80 0x03, BLUETOOTH_DATA_TYPE_INCOMPLETE_LIST_OF_16_BIT_SERVICE_CLASS_UUIDS, 0x11, 0x11, 81 }; 82 const uint8_t adv_data_len = sizeof(adv_data); 83 84 static void sm_peripheral_setup(void){ 85 86 l2cap_init(); 87 88 // setup le device db 89 le_device_db_init(); 90 91 // setup SM: Display only 92 sm_init(); 93 94 // setup ATT server 95 att_server_init(profile_data, NULL, NULL); 96 97 // setup GATT Client 98 gatt_client_init(); 99 100 // setup advertisements 101 uint16_t adv_int_min = 0x0030; 102 uint16_t adv_int_max = 0x0030; 103 uint8_t adv_type = 0; 104 bd_addr_t null_addr; 105 memset(null_addr, 0, 6); 106 gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00); 107 gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data); 108 gap_advertisements_enable(1); 109 110 // register for SM events 111 sm_event_callback_registration.callback = &packet_handler; 112 sm_add_event_handler(&sm_event_callback_registration); 113 114 // register for ATT 115 att_server_register_packet_handler(packet_handler); 116 117 118 // Configuration 119 120 // Enable mandatory authentication for GATT Client 121 // - if un-encrypted connections are not supported, e.g. when connecting to own device, this enforces authentication 122 // gatt_client_set_required_security_level(LEVEL_2); 123 124 /** 125 * Choose ONE of the following configurations 126 * Bonding is disabled to allow for repeated testing. It can be enabled by or'ing 127 * SM_AUTHREQ_BONDING to the authentication requirements like this: 128 * sm_set_authentication_requirements( X | SM_AUTHREQ_BONDING) 129 */ 130 131 // LE Legacy Pairing, Just Works 132 // sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT); 133 // sm_set_authentication_requirements(0); 134 135 // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays 136 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 137 // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION); 138 // sm_use_fixed_passkey_in_display_role(123456); 139 140 #ifdef ENABLE_LE_SECURE_CONNECTIONS 141 142 // enable LE Secure Connections Only mode - disables Legacy pairing 143 // sm_set_secure_connections_only_mode(true); 144 145 // LE Secure Connections, Just Works 146 // sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT); 147 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION); 148 149 // LE Secure Connections, Numeric Comparison 150 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 151 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 152 153 // LE Secure Pairing, Passkey entry initiator enter, responder (us) displays 154 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 155 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 156 // sm_use_fixed_passkey_in_display_role(123456); 157 158 // LE Secure Pairing, Passkey entry initiator displays, responder (us) enter 159 // sm_set_io_capabilities(IO_CAPABILITY_KEYBOARD_ONLY); 160 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 161 #endif 162 } 163 164 /* LISTING_END */ 165 166 /* 167 * @section Packet Handler 168 * 169 * @text The packet handler is used to: 170 * - report connect/disconnect 171 * - handle Security Manager events 172 */ 173 174 /* LISTING_START(packetHandler): Packet Handler */ 175 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 176 UNUSED(channel); 177 UNUSED(size); 178 179 if (packet_type != HCI_EVENT_PACKET) return; 180 181 hci_con_handle_t con_handle; 182 bd_addr_t addr; 183 bd_addr_type_t addr_type; 184 uint8_t status; 185 186 switch (hci_event_packet_get_type(packet)) { 187 case HCI_EVENT_LE_META: 188 switch (hci_event_le_meta_get_subevent_code(packet)) { 189 case HCI_SUBEVENT_LE_CONNECTION_COMPLETE: 190 printf("Connection complete\n"); 191 con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet); 192 UNUSED(con_handle); 193 194 // for testing, choose one of the following actions 195 196 // manually start pairing 197 // sm_request_pairing(con_handle); 198 199 // gatt client request to authenticated characteristic in sm_pairing_central (short cut, uses hard-coded value handle) 200 // gatt_client_read_value_of_characteristic_using_value_handle(&packet_handler, con_handle, 0x0009); 201 202 // general gatt client request to trigger mandatory authentication 203 // gatt_client_discover_primary_services(&packet_handler, con_handle); 204 break; 205 default: 206 break; 207 } 208 break; 209 case SM_EVENT_JUST_WORKS_REQUEST: 210 printf("Just Works requested\n"); 211 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 212 break; 213 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 214 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 215 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 216 break; 217 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 218 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 219 break; 220 case SM_EVENT_IDENTITY_CREATED: 221 sm_event_identity_created_get_identity_address(packet, addr); 222 printf("Identity created: type %u address %s\n", sm_event_identity_created_get_identity_addr_type(packet), bd_addr_to_str(addr)); 223 break; 224 case SM_EVENT_IDENTITY_RESOLVING_SUCCEEDED: 225 sm_event_identity_resolving_succeeded_get_identity_address(packet, addr); 226 printf("Identity resolved: type %u address %s\n", sm_event_identity_resolving_succeeded_get_identity_addr_type(packet), bd_addr_to_str(addr)); 227 break; 228 case SM_EVENT_IDENTITY_RESOLVING_FAILED: 229 sm_event_identity_created_get_address(packet, addr); 230 printf("Identity resolving failed\n"); 231 break; 232 case SM_EVENT_PAIRING_STARTED: 233 printf("Pairing started\n"); 234 break; 235 case SM_EVENT_PAIRING_COMPLETE: 236 switch (sm_event_pairing_complete_get_status(packet)){ 237 case ERROR_CODE_SUCCESS: 238 printf("Pairing complete, success\n"); 239 break; 240 case ERROR_CODE_CONNECTION_TIMEOUT: 241 printf("Pairing failed, timeout\n"); 242 break; 243 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 244 printf("Pairing failed, disconnected\n"); 245 break; 246 case ERROR_CODE_AUTHENTICATION_FAILURE: 247 printf("Pairing failed, authentication failure with reason = %u\n", sm_event_pairing_complete_get_reason(packet)); 248 break; 249 default: 250 break; 251 } 252 break; 253 case SM_EVENT_REENCRYPTION_STARTED: 254 sm_event_reencryption_complete_get_address(packet, addr); 255 printf("Bonding information exists for addr type %u, identity addr %s -> re-encryption started\n", 256 sm_event_reencryption_started_get_addr_type(packet), bd_addr_to_str(addr)); 257 break; 258 case SM_EVENT_REENCRYPTION_COMPLETE: 259 switch (sm_event_reencryption_complete_get_status(packet)){ 260 case ERROR_CODE_SUCCESS: 261 printf("Re-encryption complete, success\n"); 262 break; 263 case ERROR_CODE_CONNECTION_TIMEOUT: 264 printf("Re-encryption failed, timeout\n"); 265 break; 266 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 267 printf("Re-encryption failed, disconnected\n"); 268 break; 269 case ERROR_CODE_PIN_OR_KEY_MISSING: 270 printf("Re-encryption failed, bonding information missing\n\n"); 271 printf("Assuming remote lost bonding information\n"); 272 printf("Deleting local bonding information to allow for new pairing...\n"); 273 sm_event_reencryption_complete_get_address(packet, addr); 274 addr_type = sm_event_reencryption_started_get_addr_type(packet); 275 gap_delete_bonding(addr_type, addr); 276 break; 277 default: 278 break; 279 } 280 break; 281 case GATT_EVENT_QUERY_COMPLETE: 282 status = gatt_event_query_complete_get_att_status(packet); 283 switch (status){ 284 case ATT_ERROR_INSUFFICIENT_ENCRYPTION: 285 printf("GATT Query result: Insufficient Encryption\n"); 286 break; 287 case ATT_ERROR_INSUFFICIENT_AUTHENTICATION: 288 printf("GATT Query result: Insufficient Authentication\n"); 289 break; 290 case ATT_ERROR_BONDING_INFORMATION_MISSING: 291 printf("GATT Query result: Bonding Information Missing\n"); 292 break; 293 case ATT_ERROR_SUCCESS: 294 printf("GATT Query result: OK\n"); 295 break; 296 default: 297 printf("GATT Query result: 0x%02x\n", gatt_event_query_complete_get_att_status(packet)); 298 break; 299 } 300 break; 301 default: 302 break; 303 } 304 } 305 /* LISTING_END */ 306 307 int btstack_main(void); 308 int btstack_main(void) 309 { 310 sm_peripheral_setup(); 311 312 // turn on! 313 hci_power_control(HCI_POWER_ON); 314 315 return 0; 316 } 317 /* EXAMPLE_END */ 318