xref: /btstack/src/mesh/provisioning_device.h (revision 2fca4dad957cd7b88f4657ed51e89c12615dda72)

/*
 * Copyright (C) 2017 BlueKitchen GmbH
 *
 * 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 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 the copyright holders nor the names of
 *    contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 * 4. Any redistribution, use, or modification is done solely for
 *    personal benefit and not for any commercial purpose or for
 *    monetary gain.
 *
 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN
 * GMBH 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.
 *
 * Please inquire about commercial licensing options at
 * [email protected]
 *
 */

/*
 *  provisioning_device.h
 */

#ifndef __PROVISIONING_DEVICE_H
#define __PROVISIONING_DEVICE_H

#include <stdint.h>

#include "btstack_defines.h"

#include "mesh/mesh_keys.h"

#ifdef __cplusplus
extern "C"
{
#endif

/**
 * @brief Init Provisioning in Device Role with device UUID
 */
void provisioning_device_init(void);


/**
 * @brief Register packet handler
 * @param packet_handler
 */
void provisioning_device_register_packet_handler(btstack_packet_handler_t packet_handler);

/**
 * @brief Public Key OOB Available
 * @param public_key  (64 bytes), need to stay valid forever
 * @param private_key (32 bytes), need to stay valid forever
 * @note Requires ability to transmit public key out-of-band. Memory needs to stay available. Only works with Software ECC.
 */
void provisioning_device_set_public_key_oob(const uint8_t * public_key, const uint8_t * private_key);

/**
 * @brief Static OOB Available
 * @param static_oob_len in bytes
 * @param static_oob_data
 */
void provisioning_device_set_static_oob(uint16_t static_oob_len, const uint8_t * static_oob_data);

/**
 * @brief Configure Output OOB Options
 * @param supported_output_oob_action_types bitfield
 * @param max_oob_output_size in bytes
 */
void provisioning_device_set_output_oob_actions(uint16_t supported_output_oob_action_types, uint8_t max_oob_output_size);

/**
 * @brief Configure Input OOB Options
 * @param supported_input_oob_action_types bitfield
 * @param max_oob_input_size in bytes
 */
void provisioning_device_set_input_oob_actions(uint16_t supported_input_oob_action_types, uint8_t max_oob_input_size);

/**
 * @brief Input OOB Complete Numeric
 * @param pv_adv_cid
 * @Param input_oob number
 */
void provisioning_device_input_oob_complete_numeric(uint16_t pb_adv_cid, uint32_t input_oob);

/**
 * @brief Input OOB Complete Alphanumeric
 * @param pv_adv_cid
 * @Param input_oob_data string
 * @Param input_oob_len
 */
void provisioning_device_input_oob_complete_alphanumeric(uint16_t pb_adv_cid, const uint8_t * input_oob_data, uint16_t input_oob_len);

/**
 * @brief Get provisioning data after provisioning completed
 * @param provisioning_data
 */
void provisioning_device_data_get(mesh_provisioning_data_t * provisioning_data);

#ifdef __cplusplus
} /* end of extern "C" */
#endif

#endif