Important changes to repositories hosted on mbed.com
Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.
To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.
It is also possible to export all your personal repositories from the account settings page.
Dependents: TYBLE16_simple_data_logger TYBLE16_MP3_Air
ws_bbr_api.h File Reference
Wi-SUN backbone border router (BBR) application interface. More...
Go to the source code of this file.
Functions | |
| int | ws_bbr_start (int8_t interface_id, int8_t backbone_interface_id) |
| Start backbone border router service. | |
| int | ws_bbr_configure (int8_t interface_id, uint16_t options) |
| Configure border router features. | |
| void | ws_bbr_stop (int8_t interface_id) |
| Stop backbone Border router. | |
| int | ws_bbr_node_keys_remove (int8_t interface_id, uint8_t *eui64) |
| Remove node's keys from border router. | |
| int | ws_bbr_node_access_revoke_start (int8_t interface_id) |
| Start revocation of node's access. | |
| int | ws_bbr_eapol_node_limit_set (int8_t interface_id, uint16_t limit) |
| Set EAPOL node limit. | |
| int | ws_bbr_ext_certificate_validation_set (int8_t interface_id, uint8_t validation) |
| Sets extended certificate validation setting. | |
Detailed Description
Wi-SUN backbone border router (BBR) application interface.
This is Wi-SUN backbone Border router service. When started the module takes care of starting the components that enables default border router functionality in Wi-SUN network.
Definition in file ws_bbr_api.h.
Function Documentation
| int ws_bbr_configure | ( | int8_t | interface_id, |
| uint16_t | options | ||
| ) |
Configure border router features.
- Parameters:
-
interface_id interface ID of the Wi-SUN network options Options configured to Border router BBR_ULA_C Configure Mesh local ULA prefix with SLAAC address BBR_GUA_ROUTE Add more specific route for GUA BBR_BB_WAIT Start Wi-SUN network only when backbone is ready
By default Wi-SUN network is started and is treated as separate interface even if backbone is not available.
Default route RPL options when backbone is set up. RPL root is always Grounded
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 625 of file ws_bbr_api.c.
| int ws_bbr_eapol_node_limit_set | ( | int8_t | interface_id, |
| uint16_t | limit | ||
| ) |
Set EAPOL node limit.
Border router stores EAPOL key information for each authenticated node. Sets the maximum number of EAPOL nodes stored by border router. If count of node's exceed the limit, border router deletes the node information starting from oldest node (node that has authenticated longest time ago), to make room for new nodes. When network keys are updated, nodes which have been removed from storage, must make full authentication again. Value for this parameter should be set to be more than maximum amount of nodes that are expected to be connected to border router.
- Parameters:
-
interface_id Network interface ID. limit Limit for nodes
- Returns:
- 0, Node limit set
- <0 Node limit set failed.
Definition at line 665 of file ws_bbr_api.c.
| int ws_bbr_ext_certificate_validation_set | ( | int8_t | interface_id, |
| uint8_t | validation | ||
| ) |
Sets extended certificate validation setting.
Sets extended certificate validation setting on border router. Function can be used to set which fields on client certificate are validated.
- Parameters:
-
interface_id Network interface ID validation Extended Certificate validation setting BBR_CRT_EXT_VALID_NONE Do not make extended validations BBR_CRT_EXT_VALID_WISUN Validate Wi-SUN specific fields
- Returns:
- 0 Validation setting was set
- <0 Setting set failed
Definition at line 676 of file ws_bbr_api.c.
| int ws_bbr_node_access_revoke_start | ( | int8_t | interface_id ) |
Start revocation of node's access.
Starts revocation of node's access procedure on border router. Before the call to this function, authentication service must be configured to reject authentication attempts of the removed nodes (e.g. certificates of the nodes are revoked). Also the keys for the nodes must be removed from the border router.
- Parameters:
-
interface_id Network interface ID.
- Returns:
- 0, Revocation started OK.
- <0 Revocation start failed.
Definition at line 655 of file ws_bbr_api.c.
| int ws_bbr_node_keys_remove | ( | int8_t | interface_id, |
| uint8_t * | eui64 | ||
| ) |
Remove node's keys from border router.
Removes node's keys from border router i.e. Pairwise Master Key (PMK) and Pairwise Transient Key (PTK). This function is used on revocation of node's access procedure after authentication service is configured to reject authentication attempts of the node (e.g. node's certificate is revoked). Sub sequential calls to function can be used to remove several nodes from border router.
- Parameters:
-
interface_id Network interface ID. eui64 EUI-64 of revoked node
- Returns:
- 0, Node's keys has been removed
- <0 Node's key remove has failed (e.g. unknown address)
Definition at line 644 of file ws_bbr_api.c.
| int ws_bbr_start | ( | int8_t | interface_id, |
| int8_t | backbone_interface_id | ||
| ) |
Start backbone border router service.
if backbone interface is enabled and allows routing. Enables ND proxy for address found from backbone
- Parameters:
-
interface_id Wi-SUN network interface id. backbone_interface_id backbone interface id.
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 585 of file ws_bbr_api.c.
| void ws_bbr_stop | ( | int8_t | interface_id ) |
Stop backbone Border router.
- Parameters:
-
interface_id interface ID of the Wi-SUN network
- Returns:
- 0 on success
- <0 in case of errors
Definition at line 606 of file ws_bbr_api.c.
Generated on Tue Jul 12 2022 13:55:20 by
1.7.2