1 /* 2 * Copyright (C) 2011-2012 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 MATTHIAS RINGWALD 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 [email protected] 34 * 35 */ 36 37 #pragma once 38 39 #if defined __cplusplus 40 extern "C" { 41 #endif 42 43 typedef enum { 44 45 // MITM protection not required 46 // No encryption required 47 // No user interaction required 48 LEVEL_0 = 0, 49 50 // MITM protection not required 51 // No encryption required 52 // Minimal user interaction desired 53 LEVEL_1, 54 55 // MITM protection not required 56 // Encryption required 57 LEVEL_2, 58 59 // MITM protection required 60 // Encryption required 61 // User interaction acceptable 62 LEVEL_3, 63 64 // MITM protection required 65 // Encryption required 66 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 67 // User interaction acceptable 68 LEVEL_4, 69 } gap_security_level_t; 70 71 typedef enum { 72 GAP_SECURITY_NONE, 73 GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 74 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 75 // GAP_SECURITY_AUTHORIZED 76 } gap_security_state; 77 78 /** 79 * @bbrief enable/disable bonding. default is enabled 80 * @praram enabled 81 */ 82 void gap_set_bondable_mode(int enabled); 83 84 /** 85 * @brief start dedicated bonding with device. disconnect after bonding 86 * @param device 87 * @param request MITM protection 88 * @returns error, if max num acl connections active 89 * @result GAP_DEDICATED_BONDING_COMPLETE 90 */ 91 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 92 93 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 94 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 95 96 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 97 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 98 99 #if defined __cplusplus 100 } 101 #endif 102 103