1 /* SPDX-License-Identifier: GPL-2.0 */
2 /*
3 BlueZ - Bluetooth protocol stack for Linux
4 Copyright (C) 2011 Nokia Corporation and/or its subsidiary(-ies).
5
6 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
7 OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
8 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD PARTY RIGHTS.
9 IN NO EVENT SHALL THE COPYRIGHT HOLDER(S) AND AUTHOR(S) BE LIABLE FOR ANY
10 CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES
11 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
12 ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
13 OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
14
15 ALL LIABILITY, INCLUDING LIABILITY FOR INFRINGEMENT OF ANY PATENTS,
16 COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS, RELATING TO USE OF THIS
17 SOFTWARE IS DISCLAIMED.
18 */
19
20 #ifndef __SMP_H
21 #define __SMP_H
22
23 struct smp_command_hdr {
24 __u8 code;
25 } __packed;
26
27 #define SMP_CMD_PAIRING_REQ 0x01
28 #define SMP_CMD_PAIRING_RSP 0x02
29 struct smp_cmd_pairing {
30 __u8 io_capability;
31 __u8 oob_flag;
32 __u8 auth_req;
33 __u8 max_key_size;
34 __u8 init_key_dist;
35 __u8 resp_key_dist;
36 } __packed;
37
38 #define SMP_IO_DISPLAY_ONLY 0x00
39 #define SMP_IO_DISPLAY_YESNO 0x01
40 #define SMP_IO_KEYBOARD_ONLY 0x02
41 #define SMP_IO_NO_INPUT_OUTPUT 0x03
42 #define SMP_IO_KEYBOARD_DISPLAY 0x04
43
44 #define SMP_OOB_NOT_PRESENT 0x00
45 #define SMP_OOB_PRESENT 0x01
46
47 #define SMP_DIST_ENC_KEY 0x01
48 #define SMP_DIST_ID_KEY 0x02
49 #define SMP_DIST_SIGN 0x04
50 #define SMP_DIST_LINK_KEY 0x08
51
52 #define SMP_AUTH_NONE 0x00
53 #define SMP_AUTH_BONDING 0x01
54 #define SMP_AUTH_MITM 0x04
55 #define SMP_AUTH_SC 0x08
56 #define SMP_AUTH_KEYPRESS 0x10
57 #define SMP_AUTH_CT2 0x20
58
59 #define SMP_CMD_PAIRING_CONFIRM 0x03
60 struct smp_cmd_pairing_confirm {
61 __u8 confirm_val[16];
62 } __packed;
63
64 #define SMP_CMD_PAIRING_RANDOM 0x04
65 struct smp_cmd_pairing_random {
66 __u8 rand_val[16];
67 } __packed;
68
69 #define SMP_CMD_PAIRING_FAIL 0x05
70 struct smp_cmd_pairing_fail {
71 __u8 reason;
72 } __packed;
73
74 #define SMP_CMD_ENCRYPT_INFO 0x06
75 struct smp_cmd_encrypt_info {
76 __u8 ltk[16];
77 } __packed;
78
79 #define SMP_CMD_INITIATOR_IDENT 0x07
80 struct smp_cmd_initiator_ident {
81 __le16 ediv;
82 __le64 rand;
83 } __packed;
84
85 #define SMP_CMD_IDENT_INFO 0x08
86 struct smp_cmd_ident_info {
87 __u8 irk[16];
88 } __packed;
89
90 #define SMP_CMD_IDENT_ADDR_INFO 0x09
91 struct smp_cmd_ident_addr_info {
92 __u8 addr_type;
93 bdaddr_t bdaddr;
94 } __packed;
95
96 #define SMP_CMD_SIGN_INFO 0x0a
97 struct smp_cmd_sign_info {
98 __u8 csrk[16];
99 } __packed;
100
101 #define SMP_CMD_SECURITY_REQ 0x0b
102 struct smp_cmd_security_req {
103 __u8 auth_req;
104 } __packed;
105
106 #define SMP_CMD_PUBLIC_KEY 0x0c
107 struct smp_cmd_public_key {
108 __u8 x[32];
109 __u8 y[32];
110 } __packed;
111
112 #define SMP_CMD_DHKEY_CHECK 0x0d
113 struct smp_cmd_dhkey_check {
114 __u8 e[16];
115 } __packed;
116
117 #define SMP_CMD_KEYPRESS_NOTIFY 0x0e
118 struct smp_cmd_keypress_notify {
119 __u8 value;
120 } __packed;
121
122 #define SMP_CMD_MAX 0x0e
123
124 #define SMP_PASSKEY_ENTRY_FAILED 0x01
125 #define SMP_OOB_NOT_AVAIL 0x02
126 #define SMP_AUTH_REQUIREMENTS 0x03
127 #define SMP_CONFIRM_FAILED 0x04
128 #define SMP_PAIRING_NOTSUPP 0x05
129 #define SMP_ENC_KEY_SIZE 0x06
130 #define SMP_CMD_NOTSUPP 0x07
131 #define SMP_UNSPECIFIED 0x08
132 #define SMP_REPEATED_ATTEMPTS 0x09
133 #define SMP_INVALID_PARAMS 0x0a
134 #define SMP_DHKEY_CHECK_FAILED 0x0b
135 #define SMP_NUMERIC_COMP_FAILED 0x0c
136 #define SMP_BREDR_PAIRING_IN_PROGRESS 0x0d
137 #define SMP_CROSS_TRANSP_NOT_ALLOWED 0x0e
138 #define SMP_KEY_REJECTED 0x0f
139
140 #define SMP_MIN_ENC_KEY_SIZE 7
141 #define SMP_MAX_ENC_KEY_SIZE 16
142
143 /* LTK types used in internal storage (struct smp_ltk) */
144 enum {
145 SMP_STK,
146 SMP_LTK,
147 SMP_LTK_RESPONDER,
148 SMP_LTK_P256,
149 SMP_LTK_P256_DEBUG,
150 };
151
smp_ltk_is_sc(struct smp_ltk * key)152 static inline bool smp_ltk_is_sc(struct smp_ltk *key)
153 {
154 switch (key->type) {
155 case SMP_LTK_P256:
156 case SMP_LTK_P256_DEBUG:
157 return true;
158 }
159
160 return false;
161 }
162
smp_ltk_sec_level(struct smp_ltk * key)163 static inline u8 smp_ltk_sec_level(struct smp_ltk *key)
164 {
165 if (key->authenticated) {
166 if (smp_ltk_is_sc(key))
167 return BT_SECURITY_FIPS;
168 else
169 return BT_SECURITY_HIGH;
170 }
171
172 return BT_SECURITY_MEDIUM;
173 }
174
175 /* Key preferences for smp_sufficient security */
176 enum smp_key_pref {
177 SMP_ALLOW_STK,
178 SMP_USE_LTK,
179 };
180
181 /* SMP Commands */
182 int smp_cancel_and_remove_pairing(struct hci_dev *hdev, bdaddr_t *bdaddr,
183 u8 addr_type)
184 __must_hold(&hdev->lock);
185 bool smp_sufficient_security(struct hci_conn *hcon, u8 sec_level,
186 enum smp_key_pref key_pref);
187 int smp_conn_security(struct hci_conn *hcon, __u8 sec_level);
188 int smp_user_confirm_reply(struct hci_conn *conn, u16 mgmt_op, __le32 passkey)
189 __must_hold(&conn->hdev->lock);
190
191 bool smp_irk_matches(struct hci_dev *hdev, const u8 irk[16],
192 const bdaddr_t *bdaddr);
193 int smp_generate_rpa(struct hci_dev *hdev, const u8 irk[16], bdaddr_t *rpa);
194 int smp_generate_oob(struct hci_dev *hdev, u8 hash[16], u8 rand[16]);
195
196 int smp_force_bredr(struct hci_dev *hdev, bool enable);
197
198 int smp_register(struct hci_dev *hdev);
199 void smp_unregister(struct hci_dev *hdev);
200
201 #if IS_ENABLED(CONFIG_BT_SELFTEST_SMP)
202
203 int bt_selftest_smp(void);
204
205 #else
206
bt_selftest_smp(void)207 static inline int bt_selftest_smp(void)
208 {
209 return 0;
210 }
211
212 #endif
213
214 #endif /* __SMP_H */
215