thread_commissioning_if.h

00001 /*
00002  * Copyright (c) 2015-2017, Arm Limited and affiliates.
00003  * SPDX-License-Identifier: BSD-3-Clause
00004  *
00005  * Redistribution and use in source and binary forms, with or without
00006  * modification, are permitted provided that the following conditions are met:
00007  *
00008  * 1. Redistributions of source code must retain the above copyright
00009  *    notice, this list of conditions and the following disclaimer.
00010  * 2. Redistributions in binary form must reproduce the above copyright
00011  *    notice, this list of conditions and the following disclaimer in the
00012  *    documentation and/or other materials provided with the distribution.
00013  * 3. Neither the name of the copyright holder nor the
00014  *    names of its contributors may be used to endorse or promote products
00015  *    derived from this software without specific prior written permission.
00016  *
00017  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
00018  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00019  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00020  * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
00021  * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
00022  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
00023  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
00024  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
00025  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
00026  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
00027  * POSSIBILITY OF SUCH DAMAGE.
00028  */
00029 
00030 /**
00031  * \file thread_commissioning_if.h
00032  * \brief Thread internal commissioning if.
00033  *
00034  */
00035 
00036 #ifndef NANOSTACK_THREAD_COMMISSIONING_IF_H_
00037 #define NANOSTACK_THREAD_COMMISSIONING_IF_H_
00038 
00039 #include "ns_types.h"
00040 
00041 /**
00042  * This interface is used in commissioning for all the devices attaching to New Thread network.
00043  */
00044 
00045 int thread_commissioning_if_pairwise_key_add(int8_t interface_id, uint32_t valid_life_time, uint8_t eui64[static 8], uint8_t key[static 16]);
00046 
00047 /**
00048  * Delete pairwise key for specific device.
00049  *
00050  * \param interface_id Network Interface
00051  * \param eui64 eui64 of device that key is valid for.
00052  *
00053  * return 0, OK
00054  * return -1 fail
00055  */
00056 int thread_commissioning_if_pairwise_key_del(int8_t interface_id, uint8_t eui64[static 8]);
00057 
00058 /**
00059  * Delete all pairwise keys from the device.
00060  *
00061  * \param interface_id Network Interface
00062  *
00063  * return 0, OK
00064  * return -1 fail
00065  */
00066 int thread_commissioning_if_pairwise_key_delete_all(int8_t interface_id);
00067 
00068 /**
00069  * Get commissioner border router locator.
00070  *
00071  * \param interface_id Network Interface
00072  * \param address_ptr 16 byte buffer where address is written
00073  *
00074  * return 0, OK
00075  * return -1 fail
00076  */
00077 int thread_commissioning_if_border_router_locator_get(int8_t interface_id, uint8_t *address_ptr);
00078 
00079 /** @todo
00080  * This function is interop hack only and should not exists when proper commissioner
00081  * joiner implementation is made. The Link configuration is learned during commissioning and should be
00082  * updated using new function in thread management interface thread_managenet_configuration_set.
00083  * functions
00084  *
00085  * */
00086 int thread_commissioning_if_enable_security(int8_t interface_id);
00087 #endif /* NANOSTACK_THREAD_COMMISSIONING_IF_H_ */