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 #ifndef __GAP_H 39 #define __GAP_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 typedef enum { 46 47 // MITM protection not required 48 // No encryption required 49 // No user interaction required 50 LEVEL_0 = 0, 51 52 // MITM protection not required 53 // No encryption required 54 // Minimal user interaction desired 55 LEVEL_1, 56 57 // MITM protection not required 58 // Encryption required 59 LEVEL_2, 60 61 // MITM protection required 62 // Encryption required 63 // User interaction acceptable 64 LEVEL_3, 65 66 // MITM protection required 67 // Encryption required 68 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 69 // User interaction acceptable 70 LEVEL_4, 71 } gap_security_level_t; 72 73 typedef enum { 74 GAP_SECURITY_NONE, 75 GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 76 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 77 // GAP_SECURITY_AUTHORIZED 78 } gap_security_state; 79 80 /** 81 * @bbrief enable/disable bonding. default is enabled 82 * @praram enabled 83 */ 84 void gap_set_bondable_mode(int enabled); 85 86 /** 87 * @brief start dedicated bonding with device. disconnect after bonding 88 * @param device 89 * @param request MITM protection 90 * @returns error, if max num acl connections active 91 * @result GAP_DEDICATED_BONDING_COMPLETE 92 */ 93 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 94 95 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 96 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 97 98 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 99 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 100 101 /** @brief sets local name 102 * @note has to be done before stack starts up 103 * @param name is not copied, make sure memory is accessible during stack startup 104 */ 105 void gap_set_local_name(const char * local_name); 106 107 #if defined __cplusplus 108 } 109 #endif 110 111 #endif // __GAP_H 112