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