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_central.c" 39 40 41 // ***************************************************************************** 42 /* EXAMPLE_START(sm_pairing_central): LE Peripheral - Test pairing combinations 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 12346 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 /** 102 * Choose ONE of the following configurations 103 * Bonding is disabled to allow for repeated testing. It can be enabled with SM_AUTHREQ_BONDING 104 */ 105 106 // register handler 107 hci_event_callback_registration.callback = &hci_packet_handler; 108 hci_add_event_handler(&hci_event_callback_registration); 109 110 sm_event_callback_registration.callback = &sm_packet_handler; 111 sm_add_event_handler(&sm_event_callback_registration); 112 113 // LE Legacy Pairing, Just Works 114 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 115 // sm_set_authentication_requirements(SM_AUTHREQ_ NO_BONDING); 116 117 // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays 118 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 119 // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION); 120 // sm_use_fixed_passkey_in_display_role(FIXED_PASSKEY); 121 122 #ifdef ENABLE_LE_SECURE_CONNECTIONS 123 // LE Secure Connetions, Just Works 124 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 125 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION); 126 127 // LE Secure Connections, Numeric Comparison 128 // sm_set_io_capabilities(IO_CAPABILITY_KEYBOARD_ONLY); 129 sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO); 130 sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 131 132 // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays 133 // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY); 134 // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION); 135 // sm_use_fixed_passkey_in_display_role(FIXED_PASSKEY); 136 #endif 137 } 138 139 /* LISTING_END */ 140 141 /* @section HCI packet handler 142 * 143 * @text The HCI packet handler has to start the scanning, 144 * and to handle received advertisements. Advertisements are received 145 * as HCI event packets of the GAP_EVENT_ADVERTISING_REPORT type, 146 * see Listing HCIPacketHandler. 147 */ 148 149 /* LISTING_START(HCIPacketHandler): Scanning and receiving advertisements */ 150 151 static void hci_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 152 UNUSED(channel); 153 UNUSED(size); 154 155 if (packet_type != HCI_EVENT_PACKET) return; 156 hci_con_handle_t con_handle; 157 158 switch (hci_event_packet_get_type(packet)) { 159 case BTSTACK_EVENT_STATE: 160 // BTstack activated, get started 161 if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){ 162 printf("Start scaning!\n"); 163 gap_set_scan_parameters(1,0x0030, 0x0030); 164 gap_start_scan(); 165 } 166 break; 167 case GAP_EVENT_ADVERTISING_REPORT:{ 168 bd_addr_t address; 169 gap_event_advertising_report_get_address(packet, address); 170 uint8_t address_type = gap_event_advertising_report_get_address_type(packet); 171 uint8_t length = gap_event_advertising_report_get_data_length(packet); 172 const uint8_t * data = gap_event_advertising_report_get_data(packet); 173 // printf("Advertisement event: addr-type %u, addr %s, data[%u] ", 174 // address_type, bd_addr_to_str(address), length); 175 // printf_hexdump(data, length); 176 if (!ad_data_contains_uuid16(length, (uint8_t *) data, REMOTE_SERVICE)) break; 177 printf("Found remote with UUID %04x, connecting...\n", REMOTE_SERVICE); 178 gap_stop_scan(); 179 gap_connect(address,address_type); 180 break; 181 } 182 case HCI_EVENT_LE_META: 183 // wait for connection complete 184 if (hci_event_le_meta_get_subevent_code(packet) != HCI_SUBEVENT_LE_CONNECTION_COMPLETE) break; 185 con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet); 186 printf("Connection complete\n"); 187 // start pairing 188 sm_request_pairing(con_handle); 189 break; 190 case HCI_EVENT_ENCRYPTION_CHANGE: 191 con_handle = hci_event_encryption_change_get_connection_handle(packet); 192 printf("Connection encrypted: %u\n", hci_event_encryption_change_get_encryption_enabled(packet)); 193 break; 194 default: 195 break; 196 } 197 } 198 199 /* @section HCI packet handler 200 * 201 * @text The SM packet handler receives Security Manager Events required for pairing. 202 * It also receives events generated during Identity Resolving 203 * see Listing SMPacketHandler. 204 */ 205 206 /* LISTING_START(SMPacketHandler): Scanning and receiving advertisements */ 207 208 static void sm_packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){ 209 UNUSED(channel); 210 UNUSED(size); 211 212 if (packet_type != HCI_EVENT_PACKET) return; 213 214 switch (hci_event_packet_get_type(packet)) { 215 case SM_EVENT_JUST_WORKS_REQUEST: 216 printf("Just works requested\n"); 217 sm_just_works_confirm(sm_event_just_works_request_get_handle(packet)); 218 break; 219 case SM_EVENT_NUMERIC_COMPARISON_REQUEST: 220 printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet)); 221 sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet)); 222 break; 223 case SM_EVENT_PASSKEY_DISPLAY_NUMBER: 224 printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet)); 225 break; 226 case SM_EVENT_PASSKEY_INPUT_NUMBER: 227 printf("Passkey Input requested\n"); 228 printf("Sending fixed passkey %"PRIu32"\n", FIXED_PASSKEY); 229 sm_passkey_input(sm_event_passkey_input_number_get_handle(packet), FIXED_PASSKEY); 230 break; 231 case SM_EVENT_PAIRING_COMPLETE: 232 switch (sm_event_pairing_complete_get_status(packet)){ 233 case ERROR_CODE_SUCCESS: 234 printf("Pairing complete, success\n"); 235 break; 236 case ERROR_CODE_CONNECTION_TIMEOUT: 237 printf("Pairing failed, timeout\n"); 238 break; 239 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION: 240 printf("Pairing faileed, disconnected\n"); 241 break; 242 case ERROR_CODE_AUTHENTICATION_FAILURE: 243 printf("Pairing failed, reason = %u\n", sm_event_pairing_complete_get_reason(packet)); 244 break; 245 default: 246 break; 247 } 248 break; 249 default: 250 break; 251 } 252 } 253 /* LISTING_END */ 254 255 int btstack_main(void); 256 int btstack_main(void) 257 { 258 sm_pairing_central_setup(); 259 260 // turn on! 261 hci_power_control(HCI_POWER_ON); 262 263 return 0; 264 } 265 266 /* EXAMPLE_END */ 267