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