mirror of
https://github.com/bluekitchen/btstack.git
synced 2025-02-22 06:41:17 +00:00
111 lines
3.6 KiB
C
111 lines
3.6 KiB
C
/*
|
|
* Copyright (C) 2011-2012 BlueKitchen GmbH
|
|
*
|
|
* Redistribution and use in source and binary forms, with or without
|
|
* modification, are permitted provided that the following conditions
|
|
* are met:
|
|
*
|
|
* 1. Redistributions of source code must retain the above copyright
|
|
* notice, this list of conditions and the following disclaimer.
|
|
* 2. Redistributions in binary form must reproduce the above copyright
|
|
* notice, this list of conditions and the following disclaimer in the
|
|
* documentation and/or other materials provided with the distribution.
|
|
* 3. Neither the name of the copyright holders nor the names of
|
|
* contributors may be used to endorse or promote products derived
|
|
* from this software without specific prior written permission.
|
|
* 4. Any redistribution, use, or modification is done solely for
|
|
* personal benefit and not for any commercial purpose or for
|
|
* monetary gain.
|
|
*
|
|
* THIS SOFTWARE IS PROVIDED BY MATTHIAS RINGWALD AND CONTRIBUTORS
|
|
* ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
|
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
|
|
* FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS
|
|
* RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
|
|
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
|
|
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
|
|
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
|
|
* THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
|
|
* SUCH DAMAGE.
|
|
*
|
|
* Please inquire about commercial licensing options at contact@bluekitchen-gmbh.com
|
|
*
|
|
*/
|
|
|
|
#ifndef __GAP_H
|
|
#define __GAP_H
|
|
|
|
#if defined __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
typedef enum {
|
|
|
|
// MITM protection not required
|
|
// No encryption required
|
|
// No user interaction required
|
|
LEVEL_0 = 0,
|
|
|
|
// MITM protection not required
|
|
// No encryption required
|
|
// Minimal user interaction desired
|
|
LEVEL_1,
|
|
|
|
// MITM protection not required
|
|
// Encryption required
|
|
LEVEL_2,
|
|
|
|
// MITM protection required
|
|
// Encryption required
|
|
// User interaction acceptable
|
|
LEVEL_3,
|
|
|
|
// MITM protection required
|
|
// Encryption required
|
|
// 128-bit equivalent strength for link and encryption keys required (P-192 is not enough)
|
|
// User interaction acceptable
|
|
LEVEL_4,
|
|
} gap_security_level_t;
|
|
|
|
typedef enum {
|
|
GAP_SECURITY_NONE,
|
|
GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS
|
|
GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB
|
|
// GAP_SECURITY_AUTHORIZED
|
|
} gap_security_state;
|
|
|
|
/**
|
|
* @bbrief enable/disable bonding. default is enabled
|
|
* @praram enabled
|
|
*/
|
|
void gap_set_bondable_mode(int enabled);
|
|
|
|
/**
|
|
* @brief start dedicated bonding with device. disconnect after bonding
|
|
* @param device
|
|
* @param request MITM protection
|
|
* @returns error, if max num acl connections active
|
|
* @result GAP_DEDICATED_BONDING_COMPLETE
|
|
*/
|
|
int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required);
|
|
|
|
gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type);
|
|
gap_security_level_t gap_security_level(hci_con_handle_t con_handle);
|
|
|
|
void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level);
|
|
int gap_mitm_protection_required_for_security_level(gap_security_level_t level);
|
|
|
|
/** @brief sets local name
|
|
* @note has to be done before stack starts up
|
|
* @param name is not copied, make sure memory is accessible during stack startup
|
|
*/
|
|
void gap_set_local_name(const char * local_name);
|
|
|
|
#if defined __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif // __GAP_H
|