gazell/common/gzp.h

Go to the documentation of this file.

/* Copyright (c) 2009 Nordic Semiconductor. All Rights Reserved.
 *
 * The information contained herein is confidential property of Nordic 
 * Semiconductor ASA.Terms and conditions of usage are described in detail 
 * in NORDIC SEMICONDUCTOR STANDARD SOFTWARE LICENSE AGREEMENT. 
 *
 * Licensees are granted free, non-transferable use of the information. NO
 * WARRENTY of ANY KIND is provided. This heading must NOT be removed from
 * the file.
 *              
 * $LastChangedRevision: 226 $
 */

#ifndef __GZP_H
#define __GZP_H

#include "gzll.h"
#include "gzp_params.h"
#include <stdint.h>
#include <stdbool.h>

//-----------------------------------------------------------------------------
// Misc. defines
//-----------------------------------------------------------------------------
#define GZP_PAIRING_PIPE 0
#define GZP_DATA_PIPE 1
#define GZP_TX_RX_TRANS_DELAY 10
#define GZP_SYSTEM_ADDRESS_WIDTH 4     // Must equal Gazell address width - 1
#define GZP_VALIDATION_ID {0x32, 0x53, 0x66}
#define GZP_VALIDATION_ID_LENGTH 3
#define GZP_HOST_ID_LENGTH 5
#define GZP_SESSION_TOKEN_LENGTH GZP_HOST_ID_LENGTH
#define GZP_DYN_KEY_LENGTH (16 - GZP_VALIDATION_ID_LENGTH)

//-----------------------------------------------------------------------------
// Device -> Host packet definitions
//-----------------------------------------------------------------------------

// "Host address request" packet
#define GZP_CMD_HOST_ADDRESS_REQ_PAYLOAD_LENGTH 1

// "Host address fetch" packet
#define GZP_CMD_HOST_ADDRESS_FETCH_PAYLOAD_LENGTH 1

// "Host ID request" packet
#define GZP_CMD_HOST_ID_REQ_SESSION_TOKEN 1
#define GZP_CMD_HOST_ID_REQ_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_REQ_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH) 

#if (GZP_CMD_HOST_ID_REQ_PAYLOAD_LENGTH > 17)
#error GZP_SESSION_TOKEN_LENGTH too long. 
#endif

// "Host ID fetch" packet
#define GZP_CMD_HOST_ID_FETCH_VALIDATION_ID 1
#define GZP_CMD_HOST_ID_FETCH_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_FETCH_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)

#if (GZP_CMD_HOST_ID_FETCH_PAYLOAD_LENGTH > 17)
#error GZP_VALIDATION_ID_LENGTH set too long. 
#endif
 
// "Key update prepare" packet
#define GZP_CMD_KEY_UPDATE_PREPARE_PAYLOAD_LENGTH 1

// "Key update" packet
#define GZP_CMD_KEY_UPDATE_VALIDATION_ID 1
#define GZP_CMD_KEY_UPDATE_NEW_KEY (GZP_CMD_KEY_UPDATE_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
#define GZP_CMD_KEY_UPDATE_PAYLOAD_LENGTH (GZP_CMD_KEY_UPDATE_NEW_KEY + GZP_DYN_KEY_LENGTH)

#if (GZP_CMD_KEY_UPDATE_PAYLOAD_LENGTH > 17)
#error Sum (GZP_VALIDATION_ID_LENGTH + GZP_DYN_KEY_LENGTH) too high. 
#endif

// "Encrypted user data" packet
#define GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID 1
#define GZP_CMD_ENCRYPTED_USER_DATA_PAYLOAD ((GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH))
#define GZP_USER_DATA_PACKET_OVERHEAD ( GZP_CMD_ENCRYPTED_USER_DATA_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)  

#define GZP_ENCRYPTED_USER_DATA_MAX_LENGTH (17 - GZP_USER_DATA_PACKET_OVERHEAD)

#if(GZLL_MAX_FW_PAYLOAD_LENGTH < 17)
  #error GZLL_MAX_FW_PAYLOAD_LENGTH must be greater or equal to 17.
#endif

// General "fetch response" packet
#define GZPAR_CMD_FETCH_RESP_PAYLOAD_LENGTH 1

//-----------------------------------------------------------------------------
// Host -> Device packet definitions
//-----------------------------------------------------------------------------

// "Host address fetch" response packet
#define GZP_CMD_HOST_ADDRESS_RESP_ADDRESS 1
#define GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH (GZP_CMD_HOST_ADDRESS_RESP_ADDRESS + GZP_SYSTEM_ADDRESS_WIDTH) 

#if(GZLL_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH)
  #error GZLL_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_HOST_ADDRESS_RESP_PAYLOAD_LENGTH.
#endif

// "Host ID fetch" response packet
#define GZP_CMD_HOST_ID_FETCH_RESP_VALIDATION_ID 1
#define GZP_CMD_HOST_ID_FETCH_RESP_STATUS (GZP_CMD_HOST_ID_FETCH_RESP_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)
#define GZP_CMD_HOST_ID_FETCH_RESP_HOST_ID (GZP_CMD_HOST_ID_FETCH_RESP_STATUS + 1)
#define GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH (GZP_CMD_HOST_ID_FETCH_RESP_HOST_ID + GZP_HOST_ID_LENGTH)

#if(GZLL_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH)
  #error GZLL_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_HOST_ID_FETCH_RESP_PAYLOAD_LENGTH.
#endif

// "Key update prepare" response packet
#define GZP_CMD_KEY_UPDATE_PREPARE_RESP_SESSION_TOKEN 1
#define GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH (GZP_CMD_KEY_UPDATE_PREPARE_RESP_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH)

#if(GZLL_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH)
  #error GZLL_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_KEY_UPDATE_PREPARE_RESP_PAYLOAD_LENGTH.
#endif
 
// "Encrypted user data" response packet
#define GZP_CMD_ENCRYPTED_USER_DATA_RESP_SESSION_TOKEN 1
#define GZP_CMD_ENCRYPTED_USER_DATA_RESP_VALIDATION_ID (GZP_CMD_ENCRYPTED_USER_DATA_RESP_SESSION_TOKEN + GZP_SESSION_TOKEN_LENGTH)
#define GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH (GZP_CMD_ENCRYPTED_USER_DATA_RESP_VALIDATION_ID + GZP_VALIDATION_ID_LENGTH)

#if(GZLL_MAX_ACK_PAYLOAD_LENGTH < GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH)
  #error GZLL_MAX_ACK_PAYLOAD_LENGTH must be greater or equal to GZP_CMD_ENCRYPTED_USER_DATA_RESP_PAYLOAD_LENGTH.
#endif

#if(GZP_VALIDATION_ID_LENGTH > GZP_HOST_ID_LENGTH)
  #error GZP_HOST_ID_LENGTH should be greater or equal to GZP_VALIDATION_ID_LENGTH.
#endif

#if(GZP_SESSION_TOKEN_LENGTH != GZP_HOST_ID_LENGTH)
  #error GZP_SESSION_TOKEN_LENGTH must equal GZP_HOST_ID_LENGTH.
#endif

#ifdef GZLL_CRYPT_ENABLE
  #error Gazell encryption can not be enabled when using the Gazell pairing library. \
  GZLL_CRYPT_ENABLE must be undefined.
#endif

//-----------------------------------------------------------------------------
// Typedefs
//-----------------------------------------------------------------------------
typedef enum
{
  GZP_ID_EXCHANGE,    // "Secret key" only
  GZP_KEY_EXCHANGE,   // "Secret key" and "Host ID"
  GZP_DATA_EXCHANGE   // "Dynamic key" and "Host ID"
} gzp_key_select_t;

typedef enum
{
  GZP_CMD_HOST_ADDRESS_REQ = 0,
  GZP_CMD_HOST_ADDRESS_FETCH,
  GZP_CMD_HOST_ID_REQ,
  GZP_CMD_HOST_ID_FETCH,
  GZP_CMD_KEY_UPDATE_PREPARE,
  GZP_CMD_KEY_UPDATE,      
  GZP_CMD_ENCRYPTED_USER_DATA,
  GZP_CMD_FETCH_RESP,
  GZP_CMD_HOST_ADDRESS_RESP,
  GZP_CMD_HOST_ID_FETCH_RESP,
  GZP_CMD_KEY_UPDATE_PREPARE_RESP,
  GZP_CMD_ENCRYPTED_USER_DATA_RESP,
} gzp_cmd_t;

typedef enum
{
  GZP_ID_RESP_PENDING,
  GZP_ID_RESP_GRANTED,
  GZP_ID_RESP_REJECTED,
  GZP_ID_RESP_FAILED
} gzp_id_req_res_t;

//-----------------------------------------------------------------------------
// Misc. function prototypes
//-----------------------------------------------------------------------------

void gzp_crypt_set_session_token(const uint8_t *token);

void gzp_crypt_set_dyn_key(const uint8_t* src_key);

void gzp_crypt_get_session_token(uint8_t *dst_token);

void gzp_crypt_get_dyn_key(uint8_t *dst_key);

static bool gzp_set_host_id(const uint8_t* src);

bool gzp_get_host_id(uint8_t *dst);

void gzp_crypt_select_key(gzp_key_select_t key_select);

void gzp_crypt(uint8_t* dst, const uint8_t* src, uint8_t length);

bool gzp_validate_id(const uint8_t *src_id);

void gzp_add_validation_id(uint8_t *dst_id);

void gzp_random_numbers_generate(uint8_t *dst, uint8_t n);

void gzp_update_radio_params(const uint8_t *system_address);

void gzp_generate_channels(uint8_t *ch_dst, const uint8_t *system_address, uint8_t channel_tab_size);

void gzp_xor_cipher(uint8_t* dst, const uint8_t* src, const uint8_t* pad, uint8_t length);

void gzp_init(void);

void gzp_id_req_cancel(void);

bool gzp_address_req_send(void);

gzp_id_req_res_t gzp_id_req_send(void);

bool gzp_crypt_data_send(const uint8_t *src, uint8_t length);

void gzp_pairing_enable(bool enable);

void gzp_host_execute(void);

bool gzp_address_exchanged(void);

bool gzp_id_req_received(void);

void gzp_id_req_reject(void);

void gzp_id_req_grant(void);

bool gzp_crypt_user_data_received(void);

bool gzp_crypt_user_data_read(uint8_t* dst, uint8_t* length);

#endif