nrf_mesh_prov_types.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_TYPES_H_
#define NRF_MESH_PROV_TYPES_H_

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

#include "nrf_mesh_defines.h"

#define NRF_MESH_PROV_PUBKEY_SIZE 64

#define NRF_MESH_PROV_PRIVKEY_SIZE 32

#define NRF_MESH_PROV_ECDHSECRET_SIZE 32

#define NRF_MESH_PROV_DATANONCE_SIZE 13

#define NRF_MESH_PROV_OOB_SIZE_MAX 8

#define PROV_RANDOM_LEN (16)

#define PROV_CONFIRMATION_LEN (NRF_MESH_KEY_SIZE)

#define PROV_AUTH_LEN (NRF_MESH_KEY_SIZE)

#define PROV_SALT_LEN (NRF_MESH_KEY_SIZE)

#define PROV_NONCE_LEN (13)

#define PROV_CONFIRMATION_INPUT_LEN (17)

#define NRF_MESH_PROV_ALGORITHM_FIPS_P256EC (1u << 0)

#define NRF_MESH_PROV_OOB_PUBKEY_TYPE_INBAND (0)

#define NRF_MESH_PROV_OOB_PUBKEY_TYPE_OOB (1u << 0)


#define NRF_MESH_PROV_OOB_STATIC_TYPE_SUPPORTED (1u << 0)

#define NRF_MESH_PROV_OOB_OUTPUT_ACTION_BLINK (1u << 0)

#define NRF_MESH_PROV_OOB_OUTPUT_ACTION_BEEP (1u << 1)

#define NRF_MESH_PROV_OOB_OUTPUT_ACTION_VIBRATE (1u << 2)

#define NRF_MESH_PROV_OOB_OUTPUT_ACTION_NUMERIC (1u << 3)

#define NRF_MESH_PROV_OOB_OUTPUT_ACTION_ALPHANUMERIC (1u << 4)

#define NRF_MESH_PROV_OOB_INPUT_ACTION_PUSH (1u << 0)

#define NRF_MESH_PROV_OOB_INPUT_ACTION_TWIST (1u << 1)

#define NRF_MESH_PROV_OOB_INPUT_ACTION_ENTER_NUMBER (1u << 2)

#define NRF_MESH_PROV_OOB_INPUT_ACTION_ENTER_STRING (1u << 3)

#define NRF_MESH_PROV_OOB_INFO_SOURCE_OTHER (1u << 0) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_ELECTRONIC_OR_URI (1u << 1) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_2D_MACHINE_READABLE_CODE (1u << 2) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_BAR_CODE (1u << 3) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_NFC (1u << 4) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_NUMBER (1u << 5) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_STRING (1u << 6) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_ON_BOX (1u << 11) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_INSIDE_BOX (1u << 12) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_ON_PIECE_OF_PAPER (1u << 13) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_INSIDE_MANUAL (1u << 14) 
#define NRF_MESH_PROV_OOB_INFO_SOURCE_ON_DEVICE (1u << 15) 
typedef enum
{
 NRF_MESH_PROV_ALGORITHM_FIPS_P256, 
 NRF_MESH_PROV_ALGORITHM_RFU 
} nrf_mesh_prov_algorithm_t;

typedef enum
{
 NRF_MESH_PROV_PUBLIC_KEY_NO_OOB = 0x00, 
 NRF_MESH_PROV_PUBLIC_KEY_OOB = 0x01, 
 NRF_MESH_PROV_PUBLIC_KEY_PROHIBITED 
} nrf_mesh_prov_public_key_usage_t;

 typedef enum
 {
 NRF_MESH_PROV_OOB_METHOD_NONE = 0x00, 
 NRF_MESH_PROV_OOB_METHOD_STATIC = 0x01, 
 NRF_MESH_PROV_OOB_METHOD_OUTPUT = 0x02, 
 NRF_MESH_PROV_OOB_METHOD_INPUT = 0x03, 
 NRF_MESH_PROV_OOB_METHOD_PROHIBITED 
 } nrf_mesh_prov_oob_method_t;

 typedef enum
 {
 NRF_MESH_PROV_INPUT_ACTION_PUSH = 0x00, 
 NRF_MESH_PROV_INPUT_ACTION_TWIST = 0x01, 
 NRF_MESH_PROV_INPUT_ACTION_ENTER_NUMBER = 0x02, 
 NRF_MESH_PROV_INPUT_ACTION_ENTER_STRING = 0x03, 
 NRF_MESH_PROV_INPUT_ACTION_RFU 
 } nrf_mesh_prov_input_action_t;

 typedef enum
 {
 NRF_MESH_PROV_OUTPUT_ACTION_BLINK = 0x00, 
 NRF_MESH_PROV_OUTPUT_ACTION_BEEP = 0x01, 
 NRF_MESH_PROV_OUTPUT_ACTION_VIBRATE = 0x02, 
 NRF_MESH_PROV_OUTPUT_ACTION_DISPLAY_NUMERIC = 0x03, 
 NRF_MESH_PROV_OUTPUT_ACTION_ALPHANUMERIC = 0x04, 
 NRF_MESH_PROV_OUTPUT_ACTION_RFU 
 } nrf_mesh_prov_output_action_t;

 typedef enum
 {
 NRF_MESH_PROV_FAILURE_CODE_INVALID_PDU = 0x01, 
 NRF_MESH_PROV_FAILURE_CODE_INVALID_FORMAT = 0x02, 
 NRF_MESH_PROV_FAILURE_CODE_UNEXPECTED_PDU = 0x03, 
 NRF_MESH_PROV_FAILURE_CODE_CONFIRMATION_FAILED = 0x04, 
 NRF_MESH_PROV_FAILURE_CODE_OUT_OF_RESOURCES = 0x05, 
 NRF_MESH_PROV_FAILURE_CODE_DECRYPTION_FAILED = 0x06, 
 NRF_MESH_PROV_FAILURE_CODE_UNEXPECTED_ERROR = 0x07, 
 NRF_MESH_PROV_FAILURE_CODE_CANNOT_ASSIGN_ADDR = 0x08, 
 } nrf_mesh_prov_failure_code_t;

/*lint -align_max(push) -align_max(1) */

typedef struct __attribute((packed))
{
 uint8_t num_elements; 
 uint16_t algorithms; 
 uint8_t pubkey_type; 
 uint8_t oob_static_types; 
 uint8_t oob_output_size; 
 uint16_t oob_output_actions; 
 uint8_t oob_input_size; 
 uint16_t oob_input_actions; 
} nrf_mesh_prov_oob_caps_t;

typedef enum
{
 NRF_MESH_PROV_STATE_IDLE, 
 NRF_MESH_PROV_STATE_WAIT_LINK, 
 NRF_MESH_PROV_STATE_INVITE, 
 NRF_MESH_PROV_STATE_WAIT_CAPS, 
 NRF_MESH_PROV_STATE_WAIT_CAPS_CONFIRM, 
 NRF_MESH_PROV_STATE_WAIT_START, 
 NRF_MESH_PROV_STATE_WAIT_START_ACK, 
 NRF_MESH_PROV_STATE_WAIT_PUB_KEY_ACK, 
 NRF_MESH_PROV_STATE_WAIT_PUB_KEY, 
 NRF_MESH_PROV_STATE_WAIT_OOB_PUB_KEY, 
 NRF_MESH_PROV_STATE_WAIT_EXTERNAL_ECDH, 
 NRF_MESH_PROV_STATE_WAIT_OOB_INPUT, 
 NRF_MESH_PROV_STATE_WAIT_OOB_STATIC, 
 NRF_MESH_PROV_STATE_WAIT_OOB_STATIC_C_RCVD, 
 NRF_MESH_PROV_STATE_WAIT_CONFIRMATION_ACK, 
 NRF_MESH_PROV_STATE_WAIT_CONFIRMATION, 
 NRF_MESH_PROV_STATE_WAIT_INPUT_COMPLETE, 
 NRF_MESH_PROV_STATE_WAIT_RANDOM, 
 NRF_MESH_PROV_STATE_WAIT_DATA, 
 NRF_MESH_PROV_STATE_WAIT_COMPLETE, 
 NRF_MESH_PROV_STATE_COMPLETE, 
 NRF_MESH_PROV_STATE_FAILED 
} nrf_mesh_prov_state_t;

typedef struct __attribute((packed))
{
 uint8_t netkey[NRF_MESH_KEY_SIZE];
 uint16_t netkey_index;
 uint32_t iv_index;
 uint16_t address;
 struct __attribute((packed)) {
 uint8_t iv_update : 1;
 uint8_t key_refresh : 1;
 } flags;
} nrf_mesh_prov_provisioning_data_t;

/*lint -align_max(pop) */

typedef enum
{
 NRF_MESH_PROV_ROLE_PROVISIONER, 
 NRF_MESH_PROV_ROLE_PROVISIONEE 
} nrf_mesh_prov_role_t;

typedef struct nrf_mesh_prov_ctx nrf_mesh_prov_ctx_t;

#endif /* NRF_MESH_PROV_TYPES_H__ */