xref: /btstack/example/sm_pairing_peripheral.c (revision ab2c6ae4b737d5e801d3defe4117331eb244ebb7)
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 combinations
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 
54 #include "sm_pairing_peripheral.h"
55 #include "btstack.h"
56 
57 /* @section Main Application Setup
58  *
59  * @text Listing MainConfiguration shows main application code.
60  * It initializes L2CAP, the Security Manager and configures the ATT Server with the pre-compiled
61  * ATT Database generated from $sm_pairing_peripheral.gatt$. Finally, it configures the advertisements
62  * and boots the Bluetooth stack.
63  * In this example, the Advertisement contains the Flags attribute and the device name.
64  * The flag 0x06 indicates: LE General Discoverable Mode and BR/EDR not supported.
65  * Various examples for IO Capabilites and Authentication Requirements are given below.
66  */
67 
68 /* LISTING_START(MainConfiguration): Init L2CAP SM ATT Server and start heartbeat timer */
69 static btstack_packet_callback_registration_t hci_event_callback_registration;
70 static btstack_packet_callback_registration_t sm_event_callback_registration;
71 // static hci_con_handle_t con_handle;
72 
73 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
74 
75 const uint8_t adv_data[] = {
76     // Flags general discoverable, BR/EDR not supported
77     0x02, 0x01, 0x06,
78     // Name
79     0x0b, 0x09, 'S', 'M', ' ', 'P', 'a', 'i', 'r', 'i', 'n', 'g',
80 };
81 const uint8_t adv_data_len = sizeof(adv_data);
82 
83 static void sm_peripheral_setup(void){
84 
85     // register for HCI events
86     hci_event_callback_registration.callback = &packet_handler;
87     hci_add_event_handler(&hci_event_callback_registration);
88 
89     l2cap_init();
90 
91     // setup le device db
92     le_device_db_init();
93 
94     // setup SM: Display only
95     sm_init();
96     sm_event_callback_registration.callback = &packet_handler;
97     sm_add_event_handler(&sm_event_callback_registration);
98 
99     /**
100      * Choose ONE of the following configurations
101      */
102 
103     // LE Legacy Pairing, Just Works
104     sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT);
105     sm_set_authentication_requirements(0);
106 
107     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
108     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
109     // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION);
110 
111 #ifdef ENABLE_LE_SECURE_CONNECTIONS
112     // LE Secure Connetions, Just Works
113     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
114     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION);
115 
116     // LE Secure Connections, Numeric Comparison
117     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
118     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
119 
120     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
121     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
122     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
123 #endif
124 
125     // setup ATT server
126     att_server_init(profile_data, NULL, NULL);
127     att_server_register_packet_handler(packet_handler);
128 
129     // setup advertisements
130     uint16_t adv_int_min = 0x0030;
131     uint16_t adv_int_max = 0x0030;
132     uint8_t adv_type = 0;
133     bd_addr_t null_addr;
134     memset(null_addr, 0, 6);
135     gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00);
136     gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data);
137     gap_advertisements_enable(1);
138 }
139 
140 /* LISTING_END */
141 
142 /*
143  * @section Packet Handler
144  *
145  * @text The packet handler is used to:
146  *        - stop the counter after a disconnect
147  *        - send a notification when the requested ATT_EVENT_CAN_SEND_NOW is received
148  */
149 
150 /* LISTING_START(packetHandler): Packet Handler */
151 static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
152     UNUSED(channel);
153     UNUSED(size);
154 
155     bd_addr_t addr;
156     switch (packet_type) {
157         case HCI_EVENT_PACKET:
158             switch (hci_event_packet_get_type(packet)) {
159                 case SM_EVENT_JUST_WORKS_REQUEST:
160                     printf("Just Works requested\n");
161                     sm_just_works_confirm(sm_event_just_works_request_get_handle(packet));
162                     break;
163                 case SM_EVENT_NUMERIC_COMPARISON_REQUEST:
164                     printf("Confirming numeric comparison: %u\n", sm_event_numeric_comparison_request_get_passkey(packet));
165                     sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet));
166                     break;
167                 case SM_EVENT_PASSKEY_DISPLAY_NUMBER:
168                     printf("Display Passkey: %u\n", sm_event_passkey_display_number_get_passkey(packet));
169                     break;
170                 case SM_EVENT_IDENTITY_CREATED:
171                     sm_event_identity_created_get_identity_address(packet, addr);
172                     printf("Identity created: type %u address %s\n", sm_event_identity_created_get_identity_addr_type(packet), bd_addr_to_str(addr));
173                     break;
174                 case SM_EVENT_IDENTITY_RESOLVING_SUCCEEDED:
175                     sm_event_identity_resolving_succeeded_get_identity_address(packet, addr);
176                     printf("Identity resolved: type %u address %s\n", sm_event_identity_resolving_succeeded_get_identity_addr_type(packet), bd_addr_to_str(addr));
177                     break;
178                 case SM_EVENT_IDENTITY_RESOLVING_FAILED:
179                     sm_event_identity_created_get_address(packet, addr);
180                     printf("Identity resolving failed\n");
181                     break;
182             }
183             break;
184     }
185 }
186 /* LISTING_END */
187 
188 int btstack_main(void);
189 int btstack_main(void)
190 {
191     sm_peripheral_setup();
192 
193     // turn on!
194 	hci_power_control(HCI_POWER_ON);
195 
196     return 0;
197 }
198 /* EXAMPLE_END */
199