mbed-mesh-api: Add new Wi-SUN certificate API

Add new API for setting Wi-SUN:
-Setting own/trusted certificates
-Removing own/trusted certificates

Author: Arto Kinnunen

features/nanostack/mbed-mesh-api/mbed-mesh-api/WisunInterface.h

@@ -50,7 +50,7 @@ class WisunInterface : public MeshInterfaceNanostack {
      * \return MESH_ERROR_NONE on success.
      * \return MESH_ERROR_UNKNOWN in case of failure.
      * */
-    mesh_error_t network_name_set(char *network_name);
+    mesh_error_t set_network_name(char *network_name);
 
     /**
      * \brief Set Wi-SUN network regulatory domain, operating class and operating mode.
@@ -61,13 +61,68 @@ class WisunInterface : public MeshInterfaceNanostack {
      *
      * Function overwrites parameters defined by Mbed OS configuration.
      *
-     * \param regulatory_domain Values defined in Wi-SUN PHY-specification
-     * \param operating_class Values defined in Wi-SUN PHY-specification
-     * \param operating_mode Values defined in Wi-SUN PHY-specification
+     * \param regulatory_domain Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
+     * \param operating_class Values defined in Wi-SUN PHY-specification.  Use 0xff to use leave parameter unchanged.
+     * \param operating_mode Values defined in Wi-SUN PHY-specification. Use 0xff to use leave parameter unchanged.
      * \return MESH_ERROR_NONE on success.
      * \return MESH_ERROR_UNKNOWN in case of failure.
      * */
-    mesh_error_t network_regulatory_domain_set(uint8_t regulatory_domain = 0xff, uint8_t operating_class = 0xff, uint8_t operating_mode = 0xff);
+    mesh_error_t set_network_regulatory_domain(uint8_t regulatory_domain = 0xff, uint8_t operating_class = 0xff, uint8_t operating_mode = 0xff);
+
+    /**
+     * \brief Set own certificate and private key reference to the Wi-SUN network.
+     *
+     * Function can be called several times if intermediate certificates are used. Then each call to the function
+     * adds a certificate reference to own certificate chain. Certificates are in bottom up order i.e. the top certificate is given last.
+     *
+     * Function must be called before connecting the device i.e before first call to connect() method.
+     * Function will not copy certificate or key, therefore addresses must remain valid.
+     *
+     * \param cert Certificate address.
+     * \param cert_len Certificate length in bytes.
+     * \param cert_key Certificate key address.
+     * \param cert_key_len Certificate key length in bytes.
+     * \return MESH_ERROR_NONE on success.
+     * \return MESH_ERROR_STATE if method is called after calling connect().
+     * \return MESH_ERROR_MEMORY in case of memory allocation failure.
+     * */
+    mesh_error_t set_own_certificate(uint8_t *cert, uint16_t cert_len, uint8_t *cert_key = NULL, uint16_t cert_key_len = 0);
+
+    /**
+     * \brief Remove own certificates from the Wi-SUN network.
+     *
+     * Function must be called before connecting the device i.e before first call to connect() method.
+     *
+     * \return MESH_ERROR_NONE on success.
+     * \return MESH_ERROR_STATE if method is called after calling connect().
+     * */
+    mesh_error_t remove_own_certificates(void);
+
+    /**
+     * \brief Set trusted certificate reference to the Wi-SUN network.
+     *
+     * Function can be called several times. Certificates are in bottom up order i.e. the top certificate is given last.
+     *
+     * Function must be called before connecting the device i.e before first call to connect() method.
+     * Function will not copy certificate, therefore addresses must remain valid.
+     *
+     * \param cert Certificate address.
+     * \param cert_len Certificate length in bytes.
+     * \return MESH_ERROR_NONE on success.
+     * \return MESH_ERROR_STATE if method is called after calling connect().
+     * \return MESH_ERROR_MEMORY in case of memory allocation failure.
+     * */
+    mesh_error_t set_trusted_certificate(uint8_t *cert, uint16_t cert_len);
+
+    /**
+     * \brief Remove trusted certificates from the Wi-SUN network.
+     *
+     * Function must be called before connecting the device i.e before first call to connect() method.
+     *
+     * \return MESH_ERROR_NONE on success.
+     * \return MESH_ERROR_STATE if method is called after calling connect().
+     * */
+    mesh_error_t remove_trusted_certificates(void);
 
     /**
      * \brief Get router IP address

features/nanostack/mbed-mesh-api/source/WisunInterface.cpp

@@ -171,30 +171,82 @@ bool WisunInterface::getRouterIpAddress(char *address, int8_t len)
     return _interface->get_gateway(address, len);
 }
 
-mesh_error_t WisunInterface::network_name_set(char *network_name)
+mesh_error_t WisunInterface::set_network_name(char *network_name)
 {
     mesh_error_t ret_val = MESH_ERROR_NONE;
 
-    int status = wisun_tasklet_network_name_set(get_interface_id(), network_name);
+    int status = wisun_tasklet_set_network_name(get_interface_id(), network_name);
     if (status != 0) {
         ret_val = MESH_ERROR_UNKNOWN;
     }
 
     return ret_val;
 }
 
-mesh_error_t WisunInterface::network_regulatory_domain_set(uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode)
+mesh_error_t WisunInterface::set_network_regulatory_domain(uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode)
 {
     mesh_error_t ret_val = MESH_ERROR_NONE;
 
-    int status = wisun_tasklet_regulatory_domain_set(get_interface_id(), regulatory_domain, operating_class, operating_mode);
+    int status = wisun_tasklet_set_regulatory_domain(get_interface_id(), regulatory_domain, operating_class, operating_mode);
     if (status != 0) {
         ret_val = MESH_ERROR_UNKNOWN;
     }
 
     return ret_val;
 }
 
+mesh_error_t WisunInterface::set_own_certificate(uint8_t *cert, uint16_t cert_len, uint8_t *cert_key, uint16_t cert_key_len)
+{
+    mesh_error_t ret_val = MESH_ERROR_NONE;
+    int status =  wisun_tasklet_set_own_certificate(cert, cert_len, cert_key, cert_key_len);
+    if (status == -1) {
+        ret_val = MESH_ERROR_MEMORY;
+    } else if (status == -2) {
+        ret_val = MESH_ERROR_STATE;
+    }
+
+    return ret_val;
+}
+
+mesh_error_t WisunInterface::remove_own_certificates(void)
+{
+    mesh_error_t ret_val = MESH_ERROR_NONE;
+    int status =  wisun_tasklet_remove_own_certificates();
+    if (status == -1) {
+        ret_val = MESH_ERROR_MEMORY;
+    } else if (status == -2) {
+        ret_val = MESH_ERROR_STATE;
+    }
+
+    return ret_val;
+}
+
+mesh_error_t WisunInterface::set_trusted_certificate(uint8_t *cert, uint16_t cert_len)
+{
+    mesh_error_t ret_val = MESH_ERROR_NONE;
+    int status =  wisun_tasklet_set_trusted_certificate(cert, cert_len);
+    if (status == -1) {
+        ret_val = MESH_ERROR_MEMORY;
+    } else if (status == -2) {
+        ret_val = MESH_ERROR_STATE;
+    }
+
+    return ret_val;
+}
+
+mesh_error_t WisunInterface::remove_trusted_certificates(void)
+{
+    mesh_error_t ret_val = MESH_ERROR_NONE;
+    int status =  wisun_tasklet_remove_trusted_certificates();
+    if (status == -1) {
+        ret_val = MESH_ERROR_MEMORY;
+    } else if (status == -2) {
+        ret_val = MESH_ERROR_STATE;
+    }
+
+    return ret_val;
+}
+
 #define WISUN 0x2345
 #if MBED_CONF_NSAPI_DEFAULT_MESH_TYPE == WISUN && DEVICE_802_15_4_PHY
 MBED_WEAK MeshInterface *MeshInterface::get_target_default_instance()

features/nanostack/mbed-mesh-api/source/include/wisun_tasklet.h

@@ -64,6 +64,9 @@ void wisun_tasklet_init(void);
  *
  * \param device_id registered physical device
  * \return interface ID that can be used to communication with this interface
+ * \return -1 in case of MAC initialization fails
+ * \return -2 in case of error in parameters
+ * \return -3 in case of memory allocation error
  */
 int8_t wisun_tasklet_network_init(int8_t device_id);
 
@@ -84,7 +87,7 @@ int8_t wisun_tasklet_disconnect(bool send_cb);
  * \return 0 if network name stored successfully
  * \return < 0 in case of errors
  */
-int wisun_tasklet_network_name_set(int8_t nwk_interface_id, char *network_name_ptr);
+int wisun_tasklet_set_network_name(int8_t nwk_interface_id, char *network_name_ptr);
 
 /*
  * \brief Set Wi-SUN network regulatory domain
@@ -96,7 +99,45 @@ int wisun_tasklet_network_name_set(int8_t nwk_interface_id, char *network_name_p
  * \return 0 if regulatory domain is set successfully.
  * \return < 0 in case of errors
  */
-int wisun_tasklet_regulatory_domain_set(int8_t nwk_interface_id, uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode);
+int wisun_tasklet_set_regulatory_domain(int8_t nwk_interface_id, uint8_t regulatory_domain, uint8_t operating_class, uint8_t operating_mode);
+
+/*
+ * \brief Set own certificate to Wi-SUN network
+ *
+ * \param cert to use for networking
+ * \param cert_len
+ * \param cert_key
+ * \param cert_key_len
+ * \return 0 if certificate stored successfully
+ * \return < 0 in case of errors
+ */
+int wisun_tasklet_set_own_certificate(uint8_t *cert, uint16_t cert_len, uint8_t *cert_key, uint16_t cert_key_len);
+
+/*
+ * \brief Remove own certificate from Wi-SUN network
+ *
+  * \return 0 if certificates removed successfully
+ * \return < 0 in case of errors
+ */
+int wisun_tasklet_remove_own_certificates(void);
+
+/*
+ * \brief Set trusted certificate to Wi-SUN network
+ *
+ * \param cert to use for networking
+ * \param cert_len
+ * \return 0 if certificate stored successfully
+ * \return < 0 in case of errors
+ */
+int wisun_tasklet_set_trusted_certificate(uint8_t *cert, uint16_t cert_len);
+
+/*
+ * \brief Remove trusted certificate from Wi-SUN network
+ *
+  * \return 0 if certificates removed successfully
+ * \return < 0 in case of errors
+ */
+int wisun_tasklet_remove_trusted_certificates(void);
 
 #ifdef __cplusplus
 }