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 MATTHIAS 24 * RINGWALD 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 /** 95 * Choose ONE of the following configurations 96 * Bonding is disabled to allow for repeated testing. It can be enabled by or'ing 97 * SM_AUTHREQ_BONDING to the authentication requirements like this: 98 * sm_set_authentication_requirements( X | SM_AUTHREQ_BONDING) 99 */ 100 101 // LE Legacy Pairing, Just Works 102 // sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT); 103 // sm_set_authentication_requirements(0); 104 105 // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays 106 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 107 // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION); 108 // sm_use_fixed_passkey_in_display_role(123456); 109 110 #ifdef ENABLE_LE_SECURE_CONNECTIONS 111 112 // enable LE Secure Connections Only mode - disables Legacy pairing 113 // sm_set_secure_connections_only_mode(true); 114 115 // LE Secure Connections, Just Works 116 // sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT); 117 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION); 118 119 // LE Secure Connections, Numeric Comparison 120 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 121 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 122 123 // LE Secure Pairing, Passkey entry initiator enter, responder (us) displays 124 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 125 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 126 // sm_use_fixed_passkey_in_display_role(123456); 127 128 // LE Secure Pairing, Passkey entry initiator displays, responder (us) enter 129 // sm_set_io_capabilities(IO_CAPABILITY_KEYBOARD_ONLY); 130 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 131 #endif 132 133 // setup ATT server 134 att_server_init(profile_data, NULL, NULL); 135 136 // setup advertisements 137 uint16_t adv_int_min = 0x0030; 138 uint16_t adv_int_max = 0x0030; 139 uint8_t adv_type = 0; 140 bd_addr_t null_addr; 141 memset(null_addr, 0, 6); 142 gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00); 143 gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data); 144 gap_advertisements_enable(1); 145 146 // register for SM events 147 sm_event_callback_registration.callback = &packet_handler; 148 sm_add_event_handler(&sm_event_callback_registration); 149 150 // register for ATT 151 att_server_register_packet_handler(packet_handler); 152 } 153 154 /* LISTING_END */ 155 156 /* 157 * @section Packet Handler 158 * 159 * @text The packet handler is used to: 160 * - report connect/disconnect 161 * - handle Security Manager events 162 */ 163 164 /* LISTING_START(packetHandler): Packet Handler */ 165 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 166 UNUSED(channel); 167 UNUSED(size); 168 169 if (packet_type != HCI_EVENT_PACKET) return; 170 171 hci_con_handle_t con_handle; 172 bd_addr_t addr; 173 174 switch (hci_event_packet_get_type(packet)) { 175 case HCI_EVENT_LE_META: 176 switch (hci_event_le_meta_get_subevent_code(packet)) { 177 case HCI_SUBEVENT_LE_CONNECTION_COMPLETE: 178 printf("Connection complete\n"); 179 // Uncomment the next lines to trigger explicit pairing on connect 180 // con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet); 181 // sm_send_security_request(con_handle); 182 UNUSED(con_handle); 183 break; 184 default: 185 break; 186 } 187 break; 188 case SM_EVENT_JUST_WORKS_REQUEST: 189 printf("Just Works requested\n"); 190 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 191 break; 192 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 193 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 194 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 195 break; 196 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 197 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 198 break; 199 case SM_EVENT_IDENTITY_CREATED: 200 sm_event_identity_created_get_identity_address(packet, addr); 201 printf("Identity created: type %u address %s\n", sm_event_identity_created_get_identity_addr_type(packet), bd_addr_to_str(addr)); 202 break; 203 case SM_EVENT_IDENTITY_RESOLVING_SUCCEEDED: 204 sm_event_identity_resolving_succeeded_get_identity_address(packet, addr); 205 printf("Identity resolved: type %u address %s\n", sm_event_identity_resolving_succeeded_get_identity_addr_type(packet), bd_addr_to_str(addr)); 206 break; 207 case SM_EVENT_IDENTITY_RESOLVING_FAILED: 208 sm_event_identity_created_get_address(packet, addr); 209 printf("Identity resolving failed\n"); 210 break; 211 case SM_EVENT_PAIRING_COMPLETE: 212 switch (sm_event_pairing_complete_get_status(packet)){ 213 case ERROR_CODE_SUCCESS: 214 printf("Pairing complete, success\n"); 215 break; 216 case ERROR_CODE_CONNECTION_TIMEOUT: 217 printf("Pairing failed, timeout\n"); 218 break; 219 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 220 printf("Pairing failed, disconnected\n"); 221 break; 222 case ERROR_CODE_AUTHENTICATION_FAILURE: 223 printf("Pairing failed, reason = %u\n", sm_event_pairing_complete_get_reason(packet)); 224 break; 225 default: 226 break; 227 } 228 break; 229 case SM_EVENT_REENCRYPTION_STARTED: 230 sm_event_reencryption_complete_get_address(packet, addr); 231 printf("Bonding information exists for addr type %u, identity addr %s -> re-encryption started\n", 232 sm_event_reencryption_started_get_addr_type(packet), bd_addr_to_str(addr)); 233 break; 234 case SM_EVENT_REENCRYPTION_COMPLETE: 235 switch (sm_event_reencryption_complete_get_status(packet)){ 236 case ERROR_CODE_SUCCESS: 237 printf("Re-encryption complete, success\n"); 238 break; 239 case ERROR_CODE_CONNECTION_TIMEOUT: 240 printf("Re-encryption failed, timeout\n"); 241 break; 242 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 243 printf("Re-encryption failed, disconnected\n"); 244 break; 245 case ERROR_CODE_AUTHENTICATION_FAILURE: 246 printf("Re-encryption failed, authentication failure\n"); 247 break; 248 default: 249 break; 250 } 251 break; 252 default: 253 break; 254 } 255 } 256 /* LISTING_END */ 257 258 int btstack_main(void); 259 int btstack_main(void) 260 { 261 sm_peripheral_setup(); 262 263 // turn on! 264 hci_power_control(HCI_POWER_ON); 265 266 return 0; 267 } 268 /* EXAMPLE_END */ 269