nrf_mesh_prov.h

/* Copyright (c) 2010 - 2020, Nordic Semiconductor ASA
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form, except as embedded into a Nordic
 * Semiconductor ASA integrated circuit in a product or a software update for
 * such product, must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 *
 * 3. Neither the name of Nordic Semiconductor ASA nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * 4. This software, with or without modification, must only be used with a
 * Nordic Semiconductor ASA integrated circuit.
 *
 * 5. Any software provided in binary form under this license must not be reverse
 * engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef NRF_MESH_PROV_H__
#define NRF_MESH_PROV_H__

#include <ble.h>
#include <stdbool.h>
#include <stdint.h>

#include "nrf_mesh_config_prov.h"
#include "nrf_mesh_prov_types.h"
#include "nrf_mesh_prov_events.h"
#include "nrf_mesh_prov_bearer.h"
#include "nrf_mesh_assert.h"
#include "bitfield.h"

/* Ensure that the supported bearers only fills one uint32_t. */
NRF_MESH_STATIC_ASSERT(BITFIELD_BLOCK_COUNT(NRF_MESH_PROV_BEARER_COUNT) == 1);

#define NRF_MESH_PROV_OOB_CAPS_DEFAULT(NUM_ELEMENTS) \
 {NUM_ELEMENTS, NRF_MESH_PROV_ALGORITHM_FIPS_P256EC, 0, NRF_MESH_PROV_OOB_STATIC_TYPE_SUPPORTED, 0, 0, 0, 0}

struct nrf_mesh_prov_ctx
{
 list_node_t * p_bearers; 
 uint32_t supported_bearers; 
 prov_bearer_t * p_active_bearer; 
 nrf_mesh_prov_evt_handler_cb_t event_handler; 
 const uint8_t * p_public_key; 
 const uint8_t * p_private_key; 
 uint8_t peer_public_key[NRF_MESH_PROV_PUBKEY_SIZE]; 
 uint8_t shared_secret[NRF_MESH_PROV_ECDHSECRET_SIZE]; 
 uint8_t device_key[NRF_MESH_KEY_SIZE]; 
 uint8_t session_key[NRF_MESH_KEY_SIZE]; 
 uint8_t data_nonce[PROV_NONCE_LEN]; 
 uint8_t node_random[PROV_RANDOM_LEN]; 
 uint8_t peer_random[PROV_RANDOM_LEN]; 
 uint8_t auth_value[PROV_AUTH_LEN]; 
 uint8_t confirmation_salt[PROV_SALT_LEN]; 
 uint8_t peer_confirmation[PROV_CONFIRMATION_LEN]; 
 uint8_t confirmation_inputs[PROV_CONFIRMATION_INPUT_LEN]; 
 uint8_t oob_size; 
 uint8_t oob_action; 
 bool pubkey_oob; 
 nrf_mesh_prov_role_t role; 
 nrf_mesh_prov_failure_code_t failure_code; 
 nrf_mesh_prov_state_t state; 
 nrf_mesh_prov_oob_method_t oob_method; 
 nrf_mesh_prov_oob_caps_t capabilities; 
 nrf_mesh_prov_provisioning_data_t data; 
 uint8_t attention_duration_s; 
};
uint32_t nrf_mesh_prov_init(nrf_mesh_prov_ctx_t * p_ctx,
 const uint8_t * p_public_key,
 const uint8_t * p_private_key,
 const nrf_mesh_prov_oob_caps_t * p_caps,
 nrf_mesh_prov_evt_handler_cb_t event_handler);

uint32_t nrf_mesh_prov_bearer_add(nrf_mesh_prov_ctx_t * p_ctx,
 prov_bearer_t * p_prov_bearer);

uint32_t nrf_mesh_prov_listen(nrf_mesh_prov_ctx_t * p_ctx,
 const char * URI,
 uint16_t oob_info_sources,
 uint32_t bearer_types);

uint32_t nrf_mesh_prov_listen_stop(nrf_mesh_prov_ctx_t * p_ctx);

uint32_t nrf_mesh_prov_generate_keys(uint8_t * p_public, uint8_t * p_private);

uint32_t nrf_mesh_prov_provision(nrf_mesh_prov_ctx_t * p_ctx,
 const uint8_t * p_target_uuid,
 uint8_t attention_duration_s,
 const nrf_mesh_prov_provisioning_data_t * p_data,
 nrf_mesh_prov_bearer_type_t bearer);

uint32_t nrf_mesh_prov_oob_use(nrf_mesh_prov_ctx_t * p_ctx,
 nrf_mesh_prov_oob_method_t method,
 uint8_t action,
 uint8_t size);

uint32_t nrf_mesh_prov_auth_data_provide(nrf_mesh_prov_ctx_t * p_ctx,
 const uint8_t * p_data,
 uint8_t size);
static inline uint32_t nrf_mesh_prov_oob_number_provide(nrf_mesh_prov_ctx_t * p_ctx,
 uint32_t number)
{
 /* Input sanitation is done by nrf_mesh_prov_auth_data_provide() */
 return nrf_mesh_prov_auth_data_provide(p_ctx, (const uint8_t *) &number, p_ctx->oob_size);
}

uint32_t nrf_mesh_prov_shared_secret_provide(nrf_mesh_prov_ctx_t * p_ctx, const uint8_t * p_shared);

uint32_t nrf_mesh_prov_pubkey_provide(nrf_mesh_prov_ctx_t * p_ctx, const uint8_t * p_key);

uint32_t nrf_mesh_prov_scan_start(nrf_mesh_prov_evt_handler_cb_t event_handler);

void nrf_mesh_prov_scan_stop(void);

#endif