ProvisioningLibrary
Atmel Security Provisioning Library
atcaprov.h File Reference

Function and structure declarations for the provisioning process. More...

#include <stddef.h>
#include <stdint.h>

Go to the source code of this file.

Data Structures

struct  atcaprov_cert_info_s
 
struct  atcaprov_options_s
 Options for controlling the atcaprov_provision() function. More...
 
struct  atcaprov_data_s
 

Typedefs

typedef struct atcaprov_cert_info_s atcaprov_cert_info_t
 
typedef enum atcaprov_stage_e atcaprov_stage_t
 
typedef enum atcaprov_status_e atcaprov_status_t
 
typedef struct atcaprov_options_s atcaprov_options_t
 Options for controlling the atcaprov_provision() function. More...
 
typedef struct atcaprov_data_s atcaprov_data_t
 

Enumerations

enum  atcaprov_stage_e {
  ATCAPROV_STAGE_CONFIG_WRITE, ATCAPROV_STAGE_CONFIG_LOCK, ATCAPROV_STAGE_CONFIG_READ, ATCAPROV_STAGE_GEN_KEY,
  ATCAPROV_STAGE_CERTS_REQUEST, ATCAPROV_STAGE_CERTS_WRITE, ATCAPROV_STAGE_DATA_WRITE, ATCAPROV_STAGE_DATA_LOCK,
  ATCAPROV_STAGE_SLOTS_LOCK, ATCAPROV_STAGE_VALIDATE_CERTS
}
 
enum  atcaprov_status_e { ATCAPROV_STATUS_START, ATCAPROV_STATUS_DONE, ATCAPROV_STATUS_SKIPPED, ATCAPROV_STATUS_ERROR }
 

Functions

int atcaprov_provision (const atcaprov_options_t *options, atcaprov_data_t *data, void *user_data)
 This is the main provisioning function that should be called to start the provisioning process. More...
 

Detailed Description

Function and structure declarations for the provisioning process.

Typedef Documentation

Information required to prepare and generate a certificate request for a device.

Options for controlling the atcaprov_provision() function.

Enumeration Type Documentation

Enumerator
ATCAPROV_STAGE_CONFIG_WRITE 
ATCAPROV_STAGE_CONFIG_LOCK 
ATCAPROV_STAGE_CONFIG_READ 
ATCAPROV_STAGE_GEN_KEY 
ATCAPROV_STAGE_CERTS_REQUEST 
ATCAPROV_STAGE_CERTS_WRITE 
ATCAPROV_STAGE_DATA_WRITE 
ATCAPROV_STAGE_DATA_LOCK 
ATCAPROV_STAGE_SLOTS_LOCK 
ATCAPROV_STAGE_VALIDATE_CERTS 
Enumerator
ATCAPROV_STATUS_START 
ATCAPROV_STATUS_DONE 
ATCAPROV_STATUS_SKIPPED 
ATCAPROV_STATUS_ERROR 

Function Documentation

int atcaprov_provision ( const atcaprov_options_t options,
atcaprov_data_t data,
void *  user_data 
)

This is the main provisioning function that should be called to start the provisioning process.

Parameters
[in]optionsOptions controlling the provisioning process. See atcaprov_options_s for details.
[in,out]dataData buffers for returned data. See atcaprov_data_s for details.
[in]user_dataThis pointer will be passed to all the callback functions for use by the user. Set to NULL if not needed.
Returns
0 on success