xref: /btstack/example/sm_pairing_central.c (revision a4fe6467953bdb173fdf96a604f6527ed88f81c3)
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 #include "sm_pairing_central.h"
61 
62 
63 // We're looking for a remote device that lists this service in the advertisement
64 // LightBlue assigns 0x1111 as the UUID for a Blank service.
65 #define REMOTE_SERVICE 0x1111
66 
67 
68 static btstack_packet_callback_registration_t hci_event_callback_registration;
69 static btstack_packet_callback_registration_t sm_event_callback_registration;
70 
71 /* @section GAP LE setup for receiving advertisements
72  *
73  * @text GAP LE advertisements are received as custom HCI events of the
74  * GAP_EVENT_ADVERTISING_REPORT type. To receive them, you'll need to register
75  * the HCI packet handler, as shown in Listing GAPLEAdvSetup.
76  */
77 
78 /* LISTING_START(GAPLEAdvSetup): Setting up GAP LE client for receiving advertisements */
79 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
80 
81 static void sm_pairing_central_setup(void){
82     l2cap_init();
83 
84     // setup le device db
85     le_device_db_init();
86 
87     // setup SM: Display only
88     sm_init();
89 
90     // setup ATT server
91     att_server_init(profile_data, NULL, NULL);
92 
93     /**
94      * Choose ONE of the following configurations
95      */
96 
97     // register handler
98     hci_event_callback_registration.callback = &packet_handler;
99     hci_add_event_handler(&hci_event_callback_registration);
100 
101     sm_event_callback_registration.callback = &packet_handler;
102     sm_add_event_handler(&sm_event_callback_registration);
103 
104     att_server_register_packet_handler(packet_handler);
105 
106     // LE Legacy Pairing, Just Works
107     sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
108     sm_set_authentication_requirements(SM_AUTHREQ_NO_BONDING);
109 
110     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
111     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
112     // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION);
113     // sm_use_fixed_passkey_in_display_role(123456);
114 
115 #ifdef ENABLE_LE_SECURE_CONNECTIONS
116     // LE Secure Connetions, Just Works
117     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
118     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION);
119 
120     // LE Secure Connections, Numeric Comparison
121     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
122     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
123 
124     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
125     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
126     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
127     // sm_use_fixed_passkey_in_display_role(123456);
128 #endif
129 }
130 
131 /* LISTING_END */
132 
133 /* @section HCI packet handler
134  *
135  * @text The HCI packet handler has to start the scanning,
136  * and to handle received advertisements. Advertisements are received
137  * as HCI event packets of the GAP_EVENT_ADVERTISING_REPORT type,
138  * see Listing GAPLEAdvPacketHandler.
139  */
140 
141 /* LISTING_START(GAPLEAdvPacketHandler): Scanning and receiving advertisements */
142 
143 static void packet_handler(uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
144     UNUSED(channel);
145     UNUSED(size);
146 
147     if (packet_type != HCI_EVENT_PACKET) return;
148     hci_con_handle_t con_handle;
149 
150     switch (hci_event_packet_get_type(packet)) {
151         case BTSTACK_EVENT_STATE:
152             // BTstack activated, get started
153             if (btstack_event_state_get_state(packet) == HCI_STATE_WORKING){
154                 printf("Start scaning!\n");
155                 gap_set_scan_parameters(1,0x0030, 0x0030);
156                 gap_start_scan();
157             }
158             break;
159         case GAP_EVENT_ADVERTISING_REPORT:{
160             bd_addr_t address;
161             gap_event_advertising_report_get_address(packet, address);
162             uint8_t address_type = gap_event_advertising_report_get_address_type(packet);
163             uint8_t length = gap_event_advertising_report_get_data_length(packet);
164             const uint8_t * data = gap_event_advertising_report_get_data(packet);
165             printf("Advertisement event: addr-type %u, addr %s, data[%u] ",
166                address_type, bd_addr_to_str(address), length);
167             printf_hexdump(data, length);
168             if (!ad_data_contains_uuid16(length, (uint8_t *) data, REMOTE_SERVICE)) break;
169             printf("Found remote with UUID %04x, connecting...\n", REMOTE_SERVICE);
170             gap_stop_scan();
171             gap_connect(address,address_type);
172             break;
173         }
174         case SM_EVENT_JUST_WORKS_REQUEST:
175             printf("Just works requested\n");
176             sm_just_works_confirm(sm_event_just_works_request_get_handle(packet));
177             break;
178         case SM_EVENT_NUMERIC_COMPARISON_REQUEST:
179             printf("Confirming numeric comparison: %"PRIu32"\n", sm_event_numeric_comparison_request_get_passkey(packet));
180             sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet));
181             break;
182         case SM_EVENT_PASSKEY_DISPLAY_NUMBER:
183             printf("Display Passkey: %"PRIu32"\n", sm_event_passkey_display_number_get_passkey(packet));
184             break;
185         case SM_EVENT_PAIRING_COMPLETE:
186             switch (sm_event_pairing_complete_get_status(packet)){
187                 case ERROR_CODE_SUCCESS:
188                     printf("Pairing complete, success\n");
189                     break;
190                 case ERROR_CODE_CONNECTION_TIMEOUT:
191                     printf("Pairing failed, timeout\n");
192                     break;
193                 case ERROR_CODE_REMOTE_USER_TERMINATED_CONNECTION:
194                     printf("Pairing faileed, disconnected\n");
195                     break;
196                 case ERROR_CODE_AUTHENTICATION_FAILURE:
197                     printf("Pairing failed, reason = %u\n", sm_event_pairing_complete_get_reason(packet));
198                     break;
199                 default:
200                     break;
201             }
202             break;
203         case HCI_EVENT_LE_META:
204             // wait for connection complete
205             if (hci_event_le_meta_get_subevent_code(packet) != HCI_SUBEVENT_LE_CONNECTION_COMPLETE) break;
206             con_handle = hci_subevent_le_connection_complete_get_connection_handle(packet);
207             // start pairing
208             sm_request_pairing(con_handle);
209             break;
210         case HCI_EVENT_ENCRYPTION_CHANGE:
211             con_handle = hci_event_encryption_change_get_connection_handle(packet);
212             printf("Connection encrypted: %u\n", hci_event_encryption_change_get_encryption_enabled(packet));
213             break;
214         default:
215             break;
216     }
217 }
218 /* LISTING_END */
219 
220 int btstack_main(void);
221 int btstack_main(void)
222 {
223     sm_pairing_central_setup();
224 
225     // turn on!
226     hci_power_control(HCI_POWER_ON);
227 
228     return 0;
229 }
230 
231 /* EXAMPLE_END */
232