mirror of https://github.com/ARMmbed/mbed-os.git
247 lines
8.4 KiB
C
247 lines
8.4 KiB
C
/*
|
|
* Copyright (c) 2017-2019, Arm Limited and affiliates.
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
/**
|
|
* \file ws_bbr_api.h
|
|
* \brief 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.
|
|
*
|
|
*/
|
|
|
|
#ifndef WS_BBR_API_H_
|
|
#define WS_BBR_API_H_
|
|
|
|
#include "ns_types.h"
|
|
|
|
/**
|
|
* Start backbone border router service.
|
|
*
|
|
* if backbone interface is enabled and allows routing.
|
|
* Enables ND proxy for address found from backbone
|
|
*
|
|
* \param interface_id Wi-SUN network interface id.
|
|
* \param backbone_interface_id backbone interface id.
|
|
*
|
|
* \return 0 on success
|
|
* \return <0 in case of errors
|
|
*
|
|
*/
|
|
int ws_bbr_start(int8_t interface_id, int8_t backbone_interface_id);
|
|
|
|
/**
|
|
* Border router configuration options
|
|
*/
|
|
#define BBR_ULA_C 0x0001 /**< Static ULA prefix created automatically */
|
|
#define BBR_GUA_ROUTE 0x0002 /**< More specific route is added for GUA prefix */
|
|
#define BBR_BB_WAIT 0x0004 /**< Wait backbone availability before starting Wi-SUN network */
|
|
#define BBR_DEFAULT_ROUTE 0x0008 /**< Add default route parameter to DIO */
|
|
#define BBR_REQUIRE_DAO_REFRESH 0x0010 /**< Do not increment PAN version number when active forces DAO update from nodes*/
|
|
|
|
/**
|
|
* Configure border router features.
|
|
*
|
|
* \param interface_id interface ID of the Wi-SUN network
|
|
* \param 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
|
|
*
|
|
* \return 0 on success
|
|
* \return <0 in case of errors
|
|
*
|
|
*/
|
|
int ws_bbr_configure(int8_t interface_id, uint16_t options);
|
|
/**
|
|
* Stop backbone Border router.
|
|
*
|
|
* \param interface_id interface ID of the Wi-SUN network
|
|
*
|
|
* \return 0 on success
|
|
* \return <0 in case of errors
|
|
*
|
|
*/
|
|
void ws_bbr_stop(int8_t interface_id);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param eui64 EUI-64 of revoked node
|
|
*
|
|
* \return 0, Node's keys has been removed
|
|
* \return <0 Node's key remove has failed (e.g. unknown address)
|
|
*/
|
|
int ws_bbr_node_keys_remove(int8_t interface_id, uint8_t *eui64);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
*
|
|
* \return 0, Revocation started OK.
|
|
* \return <0 Revocation start failed.
|
|
*/
|
|
int ws_bbr_node_access_revoke_start(int8_t interface_id);
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param limit Limit for nodes
|
|
*
|
|
* \return 0, Node limit set
|
|
* \return <0 Node limit set failed.
|
|
*/
|
|
int ws_bbr_eapol_node_limit_set(int8_t interface_id, uint16_t limit);
|
|
|
|
/**
|
|
* Extended certificate validation
|
|
*/
|
|
#define BBR_CRT_EXT_VALID_NONE 0x00 /**< Do not make extended validations */
|
|
#define BBR_CRT_EXT_VALID_WISUN 0x01 /**< Validate Wi-SUN specific fields */
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* \param interface_id Network interface ID
|
|
* \param 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
|
|
*
|
|
* \return 0 Validation setting was set
|
|
* \return <0 Setting set failed
|
|
*/
|
|
int ws_bbr_ext_certificate_validation_set(int8_t interface_id, uint8_t validation);
|
|
|
|
/**
|
|
* Sets RPL parameters
|
|
*
|
|
* Sets RPL DIO trickle parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param dio_interval_min DIO trickle timer Imin parameter.
|
|
* \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin
|
|
* \param dio_redundancy_constant DIO trickle timer redundancy constant.
|
|
*
|
|
* \return 0, RPL parameters set.
|
|
* \return <0 Node RPL parameters set failed.
|
|
*/
|
|
int ws_bbr_rpl_parameters_set(int8_t interface_id, uint8_t dio_interval_min, uint8_t dio_interval_doublings, uint8_t dio_redundancy_constant);
|
|
|
|
/**
|
|
* Gets RPL parameters
|
|
*
|
|
* Gets RPL DIO trickle parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param dio_interval_min DIO trickle timer Imin parameter.
|
|
* \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin
|
|
* \param dio_redundancy_constant DIO trickle timer redundancy constant.
|
|
*
|
|
* \return 0, RPL parameters get.
|
|
* \return <0 Node RPL parameters get failed.
|
|
*/
|
|
int ws_bbr_rpl_parameters_get(int8_t interface_id, uint8_t *dio_interval_min, uint8_t *dio_interval_doublings, uint8_t *dio_redundancy_constant);
|
|
|
|
/**
|
|
* Validate RPL parameters
|
|
*
|
|
* Validates RPL DIO trickle parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param dio_interval_min DIO trickle timer Imin parameter.
|
|
* \param dio_interval_doublings DIO trickle timer Imax parameter as doublings of Imin
|
|
* \param dio_redundancy_constant DIO trickle timer redundancy constant.
|
|
*
|
|
* \return 0, RPL parameters validated.
|
|
* \return <0 Node RPL parameters validation failed.
|
|
*/
|
|
int ws_bbr_rpl_parameters_validate(int8_t interface_id, uint8_t dio_interval_min, uint8_t dio_interval_doublings, uint8_t dio_redundancy_constant);
|
|
|
|
/**
|
|
* Sets PAN configuration
|
|
*
|
|
* Sets PAN configuration parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param pan_id PAN ID; 0xffff default, generate the PAN ID.
|
|
*
|
|
* \return 0, PAN configuration set.
|
|
* \return <0 PAN configuration set failed.
|
|
*/
|
|
int ws_bbr_pan_configuration_set(int8_t interface_id, uint16_t pan_id);
|
|
|
|
/**
|
|
* Gets PAN configuration
|
|
*
|
|
* Gets PAN configuration parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param pan_id PAN ID; 0xffff default
|
|
*
|
|
* \return 0, PAN configuration get.
|
|
* \return <0 PAN configuration get failed.
|
|
*/
|
|
int ws_bbr_pan_configuration_get(int8_t interface_id, uint16_t *pan_id);
|
|
|
|
/**
|
|
* Validates PAN configuration
|
|
*
|
|
* Validates PAN configuration parameters.
|
|
*
|
|
* \param interface_id Network interface ID.
|
|
* \param pan_id PAN ID.
|
|
*
|
|
* \return 0, PAN configuration validated.
|
|
* \return <0 PAN configuration validation failed.
|
|
*/
|
|
int ws_bbr_pan_configuration_validate(int8_t interface_id, uint16_t pan_id);
|
|
|
|
#endif /* WS_BBR_API_H_ */
|