xref: /btstack/example/sm_pairing_peripheral.c (revision f1b34e8dd9b1fdccaf026fb61fff3e60bf7a0dd7)
1d7ee901aSMatthias Ringwald /*
2d7ee901aSMatthias Ringwald  * Copyright (C) 2014 BlueKitchen GmbH
3d7ee901aSMatthias Ringwald  *
4d7ee901aSMatthias Ringwald  * Redistribution and use in source and binary forms, with or without
5d7ee901aSMatthias Ringwald  * modification, are permitted provided that the following conditions
6d7ee901aSMatthias Ringwald  * are met:
7d7ee901aSMatthias Ringwald  *
8d7ee901aSMatthias Ringwald  * 1. Redistributions of source code must retain the above copyright
9d7ee901aSMatthias Ringwald  *    notice, this list of conditions and the following disclaimer.
10d7ee901aSMatthias Ringwald  * 2. Redistributions in binary form must reproduce the above copyright
11d7ee901aSMatthias Ringwald  *    notice, this list of conditions and the following disclaimer in the
12d7ee901aSMatthias Ringwald  *    documentation and/or other materials provided with the distribution.
13d7ee901aSMatthias Ringwald  * 3. Neither the name of the copyright holders nor the names of
14d7ee901aSMatthias Ringwald  *    contributors may be used to endorse or promote products derived
15d7ee901aSMatthias Ringwald  *    from this software without specific prior written permission.
16d7ee901aSMatthias Ringwald  * 4. Any redistribution, use, or modification is done solely for
17d7ee901aSMatthias Ringwald  *    personal benefit and not for any commercial purpose or for
18d7ee901aSMatthias Ringwald  *    monetary gain.
19d7ee901aSMatthias Ringwald  *
20d7ee901aSMatthias Ringwald  * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
21d7ee901aSMatthias Ringwald  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22d7ee901aSMatthias Ringwald  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
23d7ee901aSMatthias Ringwald  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
24d7ee901aSMatthias Ringwald  * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
25d7ee901aSMatthias Ringwald  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
26d7ee901aSMatthias Ringwald  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
27d7ee901aSMatthias Ringwald  * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
28d7ee901aSMatthias Ringwald  * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
29d7ee901aSMatthias Ringwald  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
30d7ee901aSMatthias Ringwald  * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31d7ee901aSMatthias Ringwald  * SUCH DAMAGE.
32d7ee901aSMatthias Ringwald  *
33d7ee901aSMatthias Ringwald  * Please inquire about commercial licensing options at
34d7ee901aSMatthias Ringwald  * [email protected]
35d7ee901aSMatthias Ringwald  *
36d7ee901aSMatthias Ringwald  */
37d7ee901aSMatthias Ringwald 
38d7ee901aSMatthias Ringwald // *****************************************************************************
39d7ee901aSMatthias Ringwald /* EXAMPLE_START(sm_pairing_peripheral): LE Peripheral - Test pairing combinations
40d7ee901aSMatthias Ringwald  *
41d7ee901aSMatthias Ringwald  * @text Depending on the Authentication requiremens and IO Capabilities,
42d7ee901aSMatthias Ringwald  * the pairing process uses different short and long term key generation method.
43d7ee901aSMatthias Ringwald  * This example helps explore the different options incl. LE Secure Connections.
44d7ee901aSMatthias Ringwald  */
45d7ee901aSMatthias Ringwald  // *****************************************************************************
46d7ee901aSMatthias Ringwald 
47d7ee901aSMatthias Ringwald #include <stdint.h>
48d7ee901aSMatthias Ringwald #include <stdio.h>
49d7ee901aSMatthias Ringwald #include <stdlib.h>
50d7ee901aSMatthias Ringwald #include <string.h>
51d7ee901aSMatthias Ringwald 
52d7ee901aSMatthias Ringwald #include "sm_pairing_peripheral.h"
53d7ee901aSMatthias Ringwald #include "btstack.h"
54d7ee901aSMatthias Ringwald 
55d7ee901aSMatthias Ringwald /* @section Main Application Setup
56d7ee901aSMatthias Ringwald  *
57d7ee901aSMatthias Ringwald  * @text Listing MainConfiguration shows main application code.
58d7ee901aSMatthias Ringwald  * It initializes L2CAP, the Security Manager and configures the ATT Server with the pre-compiled
59d7ee901aSMatthias Ringwald  * ATT Database generated from $sm_pairing_peripheral.gatt$. Finally, it configures the advertisements
60d7ee901aSMatthias Ringwald  * and boots the Bluetooth stack.
61d7ee901aSMatthias Ringwald  * In this example, the Advertisement contains the Flags attribute and the device name.
62d7ee901aSMatthias Ringwald  * The flag 0x06 indicates: LE General Discoverable Mode and BR/EDR not supported.
63d7ee901aSMatthias Ringwald  * Various examples for IO Capabilites and Authentication Requirements are given below.
64d7ee901aSMatthias Ringwald  */
65d7ee901aSMatthias Ringwald 
66d7ee901aSMatthias Ringwald /* LISTING_START(MainConfiguration): Init L2CAP SM ATT Server and start heartbeat timer */
67d7ee901aSMatthias Ringwald static btstack_packet_callback_registration_t hci_event_callback_registration;
68d7ee901aSMatthias Ringwald static btstack_packet_callback_registration_t sm_event_callback_registration;
69d7ee901aSMatthias Ringwald // static hci_con_handle_t con_handle;
70d7ee901aSMatthias Ringwald 
71d7ee901aSMatthias Ringwald static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size);
72d7ee901aSMatthias Ringwald 
73d7ee901aSMatthias Ringwald const uint8_t adv_data[] = {
74d7ee901aSMatthias Ringwald     // Flags general discoverable, BR/EDR not supported
75d7ee901aSMatthias Ringwald     0x02, 0x01, 0x06,
76d7ee901aSMatthias Ringwald     // Name
77d7ee901aSMatthias Ringwald     0x0b, 0x09, 'S', 'M', ' ', 'P', 'a', 'i', 'r', 'i', 'n', 'g',
78d7ee901aSMatthias Ringwald };
79d7ee901aSMatthias Ringwald const uint8_t adv_data_len = sizeof(adv_data);
80d7ee901aSMatthias Ringwald 
81d7ee901aSMatthias Ringwald static void sm_peripheral_setup(void){
82d7ee901aSMatthias Ringwald 
83d7ee901aSMatthias Ringwald     // register for HCI events
84d7ee901aSMatthias Ringwald     hci_event_callback_registration.callback = &packet_handler;
85d7ee901aSMatthias Ringwald     hci_add_event_handler(&hci_event_callback_registration);
86d7ee901aSMatthias Ringwald 
87d7ee901aSMatthias Ringwald     l2cap_init();
88d7ee901aSMatthias Ringwald 
89d7ee901aSMatthias Ringwald     // setup le device db
90d7ee901aSMatthias Ringwald     le_device_db_init();
91d7ee901aSMatthias Ringwald 
92d7ee901aSMatthias Ringwald     // setup SM: Display only
93d7ee901aSMatthias Ringwald     sm_init();
94d7ee901aSMatthias Ringwald     sm_event_callback_registration.callback = &packet_handler;
95d7ee901aSMatthias Ringwald     sm_add_event_handler(&sm_event_callback_registration);
96d7ee901aSMatthias Ringwald 
97d7ee901aSMatthias Ringwald     /**
98d7ee901aSMatthias Ringwald      * Choose ONE of the following configurations
99d7ee901aSMatthias Ringwald      */
100d7ee901aSMatthias Ringwald 
101d7ee901aSMatthias Ringwald     // LE Legacy Pairing, Just Works
102*f1b34e8dSMatthias Ringwald     sm_set_io_capabilities(IO_CAPABILITY_NO_INPUT_NO_OUTPUT);
103d7ee901aSMatthias Ringwald     sm_set_authentication_requirements(0);
104d7ee901aSMatthias Ringwald 
105d7ee901aSMatthias Ringwald     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
106d7ee901aSMatthias Ringwald     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
107d7ee901aSMatthias Ringwald     // sm_set_authentication_requirements(SM_AUTHREQ_MITM_PROTECTION);
108d7ee901aSMatthias Ringwald 
109d7ee901aSMatthias Ringwald #ifdef ENABLE_LE_SECURE_CONNECTIONS
110d7ee901aSMatthias Ringwald     // LE Secure Connetions, Just Works
111d7ee901aSMatthias Ringwald     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
112d7ee901aSMatthias Ringwald     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION);
113d7ee901aSMatthias Ringwald 
114d7ee901aSMatthias Ringwald     // LE Secure Connections, Numeric Comparison
115d7ee901aSMatthias Ringwald     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_YES_NO);
116d7ee901aSMatthias Ringwald     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
117d7ee901aSMatthias Ringwald 
118d7ee901aSMatthias Ringwald     // LE Legacy Pairing, Passkey entry initiator enter, responder (us) displays
119d7ee901aSMatthias Ringwald     // sm_set_io_capabilities(IO_CAPABILITY_DISPLAY_ONLY);
120d7ee901aSMatthias Ringwald     // sm_set_authentication_requirements(SM_AUTHREQ_SECURE_CONNECTION|SM_AUTHREQ_MITM_PROTECTION);
121d7ee901aSMatthias Ringwald #endif
122d7ee901aSMatthias Ringwald 
123d7ee901aSMatthias Ringwald     // setup ATT server
124d7ee901aSMatthias Ringwald     att_server_init(profile_data, NULL, NULL);
125d7ee901aSMatthias Ringwald     att_server_register_packet_handler(packet_handler);
126d7ee901aSMatthias Ringwald 
127d7ee901aSMatthias Ringwald     // setup advertisements
128d7ee901aSMatthias Ringwald     uint16_t adv_int_min = 0x0030;
129d7ee901aSMatthias Ringwald     uint16_t adv_int_max = 0x0030;
130d7ee901aSMatthias Ringwald     uint8_t adv_type = 0;
131d7ee901aSMatthias Ringwald     bd_addr_t null_addr;
132d7ee901aSMatthias Ringwald     memset(null_addr, 0, 6);
133d7ee901aSMatthias Ringwald     gap_advertisements_set_params(adv_int_min, adv_int_max, adv_type, 0, null_addr, 0x07, 0x00);
134d7ee901aSMatthias Ringwald     gap_advertisements_set_data(adv_data_len, (uint8_t*) adv_data);
135d7ee901aSMatthias Ringwald     gap_advertisements_enable(1);
136d7ee901aSMatthias Ringwald }
137d7ee901aSMatthias Ringwald 
138d7ee901aSMatthias Ringwald /* LISTING_END */
139d7ee901aSMatthias Ringwald 
140d7ee901aSMatthias Ringwald /*
141d7ee901aSMatthias Ringwald  * @section Packet Handler
142d7ee901aSMatthias Ringwald  *
143d7ee901aSMatthias Ringwald  * @text The packet handler is used to:
144d7ee901aSMatthias Ringwald  *        - stop the counter after a disconnect
145d7ee901aSMatthias Ringwald  *        - send a notification when the requested ATT_EVENT_CAN_SEND_NOW is received
146d7ee901aSMatthias Ringwald  */
147d7ee901aSMatthias Ringwald 
148d7ee901aSMatthias Ringwald /* LISTING_START(packetHandler): Packet Handler */
149d7ee901aSMatthias Ringwald static void packet_handler (uint8_t packet_type, uint16_t channel, uint8_t *packet, uint16_t size){
1509ec2630cSMatthias Ringwald     UNUSED(channel);
1519ec2630cSMatthias Ringwald     UNUSED(size);
1529ec2630cSMatthias Ringwald 
1539c22b849SMatthias Ringwald     bd_addr_t addr;
154d7ee901aSMatthias Ringwald     switch (packet_type) {
155d7ee901aSMatthias Ringwald         case HCI_EVENT_PACKET:
156d7ee901aSMatthias Ringwald             switch (hci_event_packet_get_type(packet)) {
157d7ee901aSMatthias Ringwald                 case SM_EVENT_JUST_WORKS_REQUEST:
158d7ee901aSMatthias Ringwald                     printf("Just Works requested\n");
159d7ee901aSMatthias Ringwald                     sm_just_works_confirm(sm_event_just_works_request_get_handle(packet));
160d7ee901aSMatthias Ringwald                     break;
161d7ee901aSMatthias Ringwald                 case SM_EVENT_NUMERIC_COMPARISON_REQUEST:
162d7ee901aSMatthias Ringwald                     printf("Confirming numeric comparison: %u\n", sm_event_numeric_comparison_request_get_passkey(packet));
163d7ee901aSMatthias Ringwald                     sm_numeric_comparison_confirm(sm_event_passkey_display_number_get_handle(packet));
164d7ee901aSMatthias Ringwald                     break;
165d7ee901aSMatthias Ringwald                 case SM_EVENT_PASSKEY_DISPLAY_NUMBER:
166d7ee901aSMatthias Ringwald                     printf("Display Passkey: %u\n", sm_event_passkey_display_number_get_passkey(packet));
167d7ee901aSMatthias Ringwald                     break;
1689c22b849SMatthias Ringwald                 case SM_EVENT_IDENTITY_CREATED:
1699c22b849SMatthias Ringwald                     sm_event_identity_created_get_identity_address(packet, addr);
1709c22b849SMatthias Ringwald                     printf("Identity created: type %u address %s\n", sm_event_identity_created_get_identity_addr_type(packet), bd_addr_to_str(addr));
1719c22b849SMatthias Ringwald                     break;
1729c22b849SMatthias Ringwald                 case SM_EVENT_IDENTITY_RESOLVING_SUCCEEDED:
1739c22b849SMatthias Ringwald                     sm_event_identity_resolving_succeeded_get_identity_address(packet, addr);
1749c22b849SMatthias Ringwald                     printf("Identity resolved: type %u address %s\n", sm_event_identity_resolving_succeeded_get_identity_addr_type(packet), bd_addr_to_str(addr));
1759c22b849SMatthias Ringwald                     break;
1769c22b849SMatthias Ringwald                 case SM_EVENT_IDENTITY_RESOLVING_FAILED:
1779c22b849SMatthias Ringwald                     sm_event_identity_created_get_address(packet, addr);
1789c22b849SMatthias Ringwald                     printf("Identity resolving failed\n");
1799c22b849SMatthias Ringwald                     break;
180d7ee901aSMatthias Ringwald             }
181d7ee901aSMatthias Ringwald             break;
182d7ee901aSMatthias Ringwald     }
183d7ee901aSMatthias Ringwald }
184d7ee901aSMatthias Ringwald /* LISTING_END */
185d7ee901aSMatthias Ringwald 
186d7ee901aSMatthias Ringwald int btstack_main(void);
187d7ee901aSMatthias Ringwald int btstack_main(void)
188d7ee901aSMatthias Ringwald {
189d7ee901aSMatthias Ringwald     sm_peripheral_setup();
190d7ee901aSMatthias Ringwald 
191d7ee901aSMatthias Ringwald     // turn on!
192d7ee901aSMatthias Ringwald 	hci_power_control(HCI_POWER_ON);
193d7ee901aSMatthias Ringwald 
194d7ee901aSMatthias Ringwald     return 0;
195d7ee901aSMatthias Ringwald }
196d7ee901aSMatthias Ringwald /* EXAMPLE_END */
197