Merge branch 'docs/improve_blufi_docs' into 'master'

docs: update BluFi documentation regarding misleading contents

Closes DOC-2836 and DOC-2701

See merge request espressif/esp-idf!18393
This commit is contained in:
Jiang Jiang Jian
2022-06-15 11:27:21 +08:00
2 changed files with 157 additions and 157 deletions

View File

@@ -5,18 +5,18 @@ BluFi
Overview
--------
The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to the {IDF_TARGET_NAME}. Using this information {IDF_TARGET_NAME} can then e.g. connect to an AP or establish a SoftAP.
The BluFi for {IDF_TARGET_NAME} is a Wi-Fi network configuration function via Bluetooth channel. It provides a secure protocol to pass Wi-Fi configuration and credentials to {IDF_TARGET_NAME}. Using this information, {IDF_TARGET_NAME} can then connect to an AP or establish a SoftAP.
Fragmenting, data encryption, checksum verification in the BluFi layer are the key elements of this process.
Fragmenting, data encryption, and checksum verification in the BluFi layer are the key elements of this process.
You can customize symmetric encryption, asymmetric encryption and checksum support customization. Here we use the DH algorithm for key negotiation, 128-AES algorithm for data encryption, and CRC16 algorithm for checksum verification.
You can customize symmetric encryption, asymmetric encryption, and checksum support customization. Here we use the DH algorithm for key negotiation, 128-AES algorithm for data encryption, and CRC16 algorithm for checksum verification.
The BluFi Flow
---------------
The BluFi networking flow includes the configuration of the SoftAP and Station.
The following uses Station as an example to illustrate the core parts of the procedure, including broadcast, connection, service discovery, negotiation of the shared key, data transmission, connection status backhaul.
The following uses Station as an example to illustrate the core parts of the procedure, including broadcast, connection, service discovery, negotiation of the shared key, data transmission, and connection status backhaul.
1. Set the {IDF_TARGET_NAME} into GATT Server mode and then it will send broadcasts with specific *advertising data*. You can customize this broadcast as needed, which is not a part of the BluFi Profile.
@@ -26,7 +26,7 @@ The following uses Station as an example to illustrate the core parts of the pro
4. After {IDF_TARGET_NAME} receives the data frame of key negotiation, it will parse the content according to the user-defined negotiation method.
5. The mobile phone works with {IDF_TARGET_NAME} for key negotiation using the encryption algorithms such as DH, RSA or ECC.
5. The mobile phone works with {IDF_TARGET_NAME} for key negotiation using the encryption algorithms, such as DH, RSA, or ECC.
6. After the negotiation process is completed, the mobile phone will send a control frame for security-mode setup to {IDF_TARGET_NAME}.
@@ -36,7 +36,7 @@ The following uses Station as an example to illustrate the core parts of the pro
9. The mobile phone sends a control frame of Wi-Fi connection request to {IDF_TARGET_NAME}. When receiving this control frame, {IDF_TARGET_NAME} will regard the communication of essential information as done and get ready to connect to the Wi-Fi.
10. After connecting to the Wi-Fi, {IDF_TARGET_NAME} will send a control frame of Wi-Fi connection status report to the mobile phoneto report the connection status. At this point the networking procedure is completed.
10. After connecting to the Wi-Fi, {IDF_TARGET_NAME} will send a control frame of Wi-Fi connection status report to the mobile phone. At this point, the networking procedure is completed.
.. note::
@@ -78,80 +78,80 @@ The Frame Formats Defined in BluFi
The frame formats for the communication between the mobile phone App and {IDF_TARGET_NAME} are defined as follows:
The frame format with no fragment (8 bit)
The frame format with no fragment:
.. list-table::
:header-rows: 1
:widths: 25 25
* - Description
- Value
* - Field
- Value (Byte)
* - Type (Least Significant Bit)
- 1
- 1
* - Frame Control
- 1
* - Sequence Number
- 1
- 1
* - Data Length
- 1
- 1
* - Data
- ${Data Length}
- ${Data Length}
* - CheckSum (Most Siginificant Bit)
- 2
- 2
If the **Frame Ctrl** bit is enabled, the **Total length** bit indicates the length of remaining part of the frame. It can tell the remote how much memory needs to be alloced.
If the frag frame bit in the **Frame Control** field is enabled, there would be a 2-byte **Total Content Length** field in the **Data** field. This **Total Content Length** field indicates the length of the remaining part of the frame and also tells the remote how much memory needs to be allocated.
The frame format with fragments8 bit
The frame format with fragments:
.. list-table::
:header-rows: 1
:widths: 25 25
* - Description
- Value
* - Field
- Value (Byte)
* - Type (Least Significant Bit)
- 1
- 1
* - Frame Control (Frag)
- 1
- 1
* - Sequence Number
- 1
- 1
* - Data Length
- 1
- 1
* - Data
- * Total Content Length: 2
* Content: ${Data Length} - 2
* Content: ${Data Length} - 2
* - CheckSum (Most Siginificant Bit)
- 2
- 2
Normally, the control frame does not contain data bits, except for ACK Frame.
The format of ACK Frame8 bit
The format of ACK Frame:
.. list-table::
:header-rows: 1
:widths: 25 25
* - Description
- Value
* - Field
- Value (Byte)
* - Type - ACK (Least Significant Bit)
- 1
- 1
* - Frame Control
- 1
- 1
* - Sequence Number
- 1
- 1
* - Data Length
- 1
- 1
* - Data
- Acked Sequence Number: 2
- Acked Sequence Number: 2
* - CheckSum (Most Siginificant Bit)
- 2
- 2
1. Type
The **Type** field, taking 1 byte, is divided into **Type** and **Subtype**, that Type uses the lower 2 bits and **Subtype** uses the upper 6 bits.
**Type** field takes 1 byte and is divided into **Type** and **Subtype**. **Type** uses the lower two bits, indicating whether the frame is a data frame or a control frame. **Subtype** uses the upper six bits, indicating the specific meaning of this data frame or control frame.
* The control frame is not encrypted for the time being and supports to be verified;
* The control frame is not encrypted for the time being and supports to be verified.
* The data frame supports to be encrypted and verified.
@@ -172,11 +172,11 @@ The format of ACK Frame8 bit
- The data field consumes a byte and its value is the same as the sequence field of the frame to reply to.
* - 0x1 (b000001)
- Set ESP device to the security mode.
- To inform ESP device of the security mode to use when sending data, which is allowed to be reset multiple times during the process. Each setting affects the subsequent security mode used.
- Set the ESP device to the security mode.
- To inform the ESP device of the security mode to use when sending data, which is allowed to be reset multiple times during the process. Each setting affects the subsequent security mode used.
If it is not set, ESP device will send the control frame and data frame with no checksum and encryption by default. The data transmission from the mobile phone to ESP device is controlled by this control frame.
- The data field consumes a byte. The higher 4 bits are for the security mode setting of the control frame, and the lower 4 bits are for the security mode setting of the data frame.
If it is not set, the ESP device will send the control frame and data frame with no checksum and encryption by default. The data transmission from the mobile phone to the ESP device is controlled by this control frame.
- The data field consumes a byte. The higher four bits are for the security mode setting of the control frame, and the lower four bits are for the security mode setting of the data frame.
* b0000: no checksum and no encryption;
* b0001: with checksum but no encryption;
@@ -185,7 +185,7 @@ The format of ACK Frame8 bit
* - 0x2 (b000010)
- Set the opmode of Wi-Fi.
- The frame contains opmode settings for configuring the Wi-Fi mode of ESP device.
- The frame contains opmode settings for configuring the Wi-Fi mode of the ESP device.
- data[0] is for opmode settings, including:
* 0x00: NULL
@@ -196,25 +196,25 @@ The format of ACK Frame8 bit
Please set the SSID/Password/Max Connection Number of the AP mode in the first place if an AP gets involved.
* - 0x3 (b000011)
- Connect ESP device to the AP.
- To notify ESP device that the essential information has been sent and it is allowed to connect to the AP.
- Connect the ESP device to the AP.
- To notify the ESP device that the essential information has been sent and it is allowed to connect to the AP.
- No data field is contained.
* - 0x4 (b000100)
- Disconnect ESP device from the AP.
- Disconnect the ESP device from the AP.
-
- No data field is contained.
* - 0x5 (b000101)
- To get the information of ESP devices Wi-Fi mode and its status.
- To get the information of the ESP devices Wi-Fi mode and its status.
-
- * No data field is contained. When receiving this control frame, ESP device will send back a follow-up frame of Wi-Fi connection state report to the mobile phone with the information of the current opmode, connection status, SSID and so on.
- * No data field is contained. When receiving this control frame, the ESP device will send back a follow-up frame of Wi-Fi connection state report to the mobile phone with the information of the current opmode, connection status, SSID, and so on.
* The types of information sent to the mobile phone is defined by the application installed on the phone.
* - 0x6 (b000110)
- Disconnect the STA device from the SoftAP (in SoftAP mode).
-
- Date[0~5] is taken as the MAC address for the STA device. If there is a second STA device, then it uses data[6-11] and the rest can be done in the same manner.
- Data[0~5] is taken as the MAC address for the STA device. If there is a second STA device, then it uses data[6-11] and the rest can be done in the same manner.
* - 0x7 (b000111)
- Get the version information.
@@ -224,12 +224,12 @@ The format of ACK Frame8 bit
* - 0x8 (b001000)
- Disconnect the BLE GATT link.
-
- ESP device will disconnect the BLE GATT link after receives this command.
- The ESP device will disconnect the BLE GATT link after receives this command.
* - 0x9 (b001001)
- Get the Wi-Fi list.
- To get ESP device to scan the Wi-Fi access points around.
- No data field is contained. When receiving this control frame, ESP device will send back a follow-up frame of Wi-Fi list report to the mobile phone.
- To get the ESP device to scan the Wi-Fi access points around.
- No data field is contained. When receiving this control frame, the ESP device will send back a follow-up frame of Wi-Fi list report to the mobile phone.
@@ -248,7 +248,7 @@ The format of ACK Frame8 bit
- The negotiation data will be sent to the callback function registered in the application layer.
- The length of the data depends on the length field.
* - 0x1 (b000001)
- Send the BSSID for STA mode.
- Send the SSID for STA mode.
- To send the BSSID of the AP for the STA device to connect under the condition that the SSID is hidden.
- Please refer to Note 1 below.
* - 0x2 (b000010)
@@ -272,7 +272,7 @@ The format of ACK Frame8 bit
-
- data[0] represents the value of the connection number, ranging from 1 to 4. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
* - 0x7 (b000111)
- Set the authentication mode for the SoftAP.
- Set the authentication mode for SoftAP mode.
-
- data[0]
@@ -282,11 +282,11 @@ The format of ACK Frame8 bit
* 0x03: WPA2_PSK
* 0x04: WPA_WPA2_PSK
When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
When the transmission direction is from the ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
* - 0x8 (b001000)
- Set the number of channels for SoftAP mode.
-
- data[0] represents the quantity of the supported channels, ranging from 1 to 14. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
- data[0] represents the quantity of the supported channels, ranging from 1 to 14. When the transmission direction is from the ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
* - 0x9 (b001001)
- Username
- It provides the username of the GATT client when using encryption of enterprise level.
@@ -321,9 +321,9 @@ The format of ACK Frame8 bit
* 0x02: SoftAP
* 0x03: SoftAP & STA
data[1]the connection state of the STA device, 0x0 indicates a connection state, and others represent a disconnected state;
data[1]: connection state of the STA device. 0x0 indicates a connection state, and others represent a disconnected state;
data[2]the connection state of the SoftAP, that is, how many STA devices have been connected.
data[2]: connection state of SoftAP. That is, how many STA devices have been connected.
data[3] and the subsequent is in accordance with the format of SSID/BSSID information.
* - 0x10 (b010000)
@@ -334,7 +334,7 @@ The format of ACK Frame8 bit
* - 0x11 (b010001)
- Wi-Fi List
- To send the Wi-Fi list to ESP device.
- The format of the data frame is length + RSSI + SSID and it supports to be sent into fragments if the data length is too long.
- The format of the data frame is length + RSSI + SSID. It supports to be sent into fragments if the data length is too long.
* - 0x12 (b010010)
- Report Error
- To notify the mobile phone that there is an error with BluFi.
@@ -354,13 +354,13 @@ The format of ACK Frame8 bit
.. note::
- Note 1: The length of the data depends on the length field. When the transmission direction is ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
- Note 1: The length of the data depends on the data length field. When the transmission direction is from the ESP device to the mobile phone, it means to provide the mobile phone with the needed information.
- Note 2: The length of the data depends on the length field. The frame supports to be fragmented if the data length is not enough.
- Note 2: The length of the data depends on the data length field. The frame supports to be fragmented if the data length is not long enough.
2. Frame Control
Control field, takes 1 byte and each bit has a different meaning.
The **Frame Control** field takes one byte and each bit has a different meaning.
.. list-table::
@@ -372,68 +372,68 @@ The format of ACK Frame8 bit
* - 0x01
- Indicates whether the frame is encrypted.
* 1 means encryption
* 0 means unencrypted
* 1 means encrypted.
* 0 means unencrypted.
The encrypted part of the frame includes the full clear data before the DATA field is encrypted (no checksum). Control frame is not encrypted, so this bit is 0.
* - 0x02
- The data field that indicates whether a frame contains a checksum (such as SHA1,MD5,CRC, etc.) for the end of the frame. Data field includes sequence + data length + clear text. Both the control frame and the data frame can contain a check bit or not.
- Indicates whether a frame contains a checksum (such as SHA1, MD5, CRC) for the end of the frame. Data field includes sequence, data length, and clear text. Both the control frame and the data frame can choose whether to contain a check bit or not.
* - 0x04
- Represents the data direction.
- Indicates the data direction.
* 0 means the mobile phone to ESP device;
* 1 means ESP device to the mobile phone.
* 0 means from the mobile phone to the ESP device.
* 1 means from the ESP device to the mobile phone.
* - 0x08
- Indicates whether the other person is required to reply to an ACK.
* 0 indicates no requirement;
* 1 indicates to reply ACK.
* 0 indicates not required to reply to an ACK.
* 1 indicates required to reply to an ACK.
* - 0x10
- Indicates whether there are subsequent data fragments.
* 0 indicates that there are no subsequent data fragments for this frame;
* 1 indicates that there are subsequent data fragments and used to transmit longer data.
* 0 indicates that there is no subsequent data fragment for this frame.
* 1 indicates that there are subsequent data fragments which used to transmit longer data.
In the case of a frag frame, the total length of the current content section + subsequent content section is given, in the first 2 bytes of the data field (that is, the content data of the maximum support 64 K).
In the case of a frag frame, the total length of the current content section + subsequent content section is given in the first two bytes of the data field (that is, the content data of the maximum support 64 K).
* - 0x10~0x80
- reserved
- Reserved
3. Sequence Control
3. Sequence Number
Sequence control field. When a frame is sent,the value of sequence fied is automatically incremented by 1 regardless of the type of frame, which prevents Replay Attack. The sequence is cleared after each reconnection.
The **Sequence Number** field is the field for sequence control. When a frame is sent, the value of this field is automatically incremented by 1 regardless of the type of frame, which prevents Replay Attack. The sequence would be cleared after each reconnection.
4. Length
4. Data Length
The length of the data field that does not include CheckSum.
The **Data Length** field indicates the length of the data field, which does not include CheckSum.
5. Data
The instruction of the data field is different according to various values of Type or Subtype. Please refer to the table above.
Content of the **Data** field can be different according to various values of Type or Subtype. Please refer to the table above.
6. CheckSum
This field takes 2 bytes that is used to check "sequence + data length + clear text data".
The **CheckSum** field takes two bytes, which is used to check "sequence + data length + clear text data".
The Security Implementation of {IDF_TARGET_NAME}
------------------------------------------------
1. Securing data
1. Securing Data
To ensure that the transmission of the Wi-Fi SSID and password is secure, the message needs to be encrypted using symmetric encryption algorithms, such as AES, DES and so on. Before using symmetric encryption algorithms, the devices are required to negotiate (or generate) a shared key using an asymmetric encryption algorithm (DH, RSA, ECC, etc).
To ensure that the transmission of the Wi-Fi SSID and password is secure, the message needs to be encrypted using symmetric encryption algorithms, such as AES, DES, and so on. Before using symmetric encryption algorithms, the devices are required to negotiate (or generate) a shared key using an asymmetric encryption algorithm (DH, RSA, ECC, etc).
2. Ensuring data integrity
2. Ensuring Data Integrity
To ensure data integrity, you need to add a checksum algorithm, such as SHA1, MD5, CRC, etc.
3. Securing identity (signature)
3. Securing Identity (Signature)
Algorithm like RSA can be used to secure identity. But for DH, it needs other algorithms as an companion for signature.
4. Replay attack prevention
4. Replay Attack Prevention
It is added to the Sequence field and used during the checksum verification.
It is added to the Sequence Number field and used during the checksum verification.
For the coding of {IDF_TARGET_NAME}, you can determine and develop the security processing, such as key negotiation. The mobile application sends the negotiation data to {IDF_TARGET_NAME} and then the data will be sent to the application layer for processing. If the application layer does not process it, you can use the DH encryption algorithm provided by BluFi to negotiate the key.
For the coding of {IDF_TARGET_NAME}, you can determine and develop the security processing, such as key negotiation. The mobile application sends the negotiation data to {IDF_TARGET_NAME}, and then the data will be sent to the application layer for processing. If the application layer does not process it, you can use the DH encryption algorithm provided by BluFi to negotiate the key.
The application layer needs to register several security-related functions to BluFi:
@@ -441,23 +441,23 @@ The Security Implementation of {IDF_TARGET_NAME}
typedef void (*esp_blufi_negotiate_data_handler_t)(uint8_t *data, int len, uint8_t **output_data, int *output_len, bool *need_free)
This function is for {IDF_TARGET_NAME} to receive normal data during negotiation, and after processing is completed, the data will be transmitted using Output_data and Output_len.
This function is for {IDF_TARGET_NAME} to receive normal data during negotiation. After processing is completed, the data will be transmitted using Output_data and Output_len.
BluFi will send output_data from Negotiate_data_handler after Negotiate_data_handler is called.
Here are two "*", because the length of the data to be emitted is unknown that requires the function to allocate itself (malloc) or point to the global variable, and to inform whether the memory needs to be freed by NEED_FREE.
Here are two "*", which means the length of the data to be emitted is unknown. Therefore, it requires the function to allocate itself (malloc) or point to the global variable to inform whether the memory needs to be freed by NEED_FREE.
.. code-block:: c
typedef int (* esp_blufi_encrypt_func_t)(uint8_t iv8, uint8_t *crypt_data, int crypt_len)
The data to be encrypted and decrypted must use the same length. The IV8 is a 8 bit sequence value of frames, which can be used as a 8 bit of IV.
The data to be encrypted and decrypted must be in the same length. The IV8 is an 8-bit sequence value of frames, which can be used as a 8-bit of IV.
.. code-block:: c
typedef int (* esp_blufi_decrypt_func_t)(uint8_t iv8, uint8_t *crypt_data, int crypt_len)
The data to be encrypted and decrypted must use the same length. The IV8 is a 8 bit sequence value of frames, which can be used as a 8 bit of IV.
The data to be encrypted and decrypted must be in the same length. The IV8 is an 8-bit sequence value of frames, which can be used as an 8-bit of IV.
.. code-block:: c