summaryrefslogtreecommitdiff
path: root/digital/zigbit/bitcloud/stack/Components/Security/ServiceProvider/include/sspAuthentic.h
blob: b1134c4a7b2f3660f1163bed6846db5b7a7eed9f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
/**************************************************************************//**
  \file sspAuthentic.h
  
  \brief Mutual Symmetric-Key Entity Authentication routine header file.

  \author
    Atmel Corporation: http://www.atmel.com \n
    Support email: avr@atmel.com

  Copyright (c) 2008-2011, Atmel Corporation. All rights reserved.
  Licensed under Atmel's Limited License Agreement (BitCloudTM).

  \internal
    History:
      29/11/07 ALuzhetsky - Created.
******************************************************************************/
#ifndef _SSPAUTHENTIC_H
#define _SSPAUTHENTIC_H

#ifdef _LINK_SECURITY_ 
/******************************************************************************
                        Includes section.
******************************************************************************/
#include <types.h>
#include <sspCommon.h>
#include <sspChallengeGen.h>

/******************************************************************************
                        Definitions section.
******************************************************************************/
#define HASH_SIZE 16

/******************************************************************************
                        Types' definition section.
******************************************************************************/

/**************************************************************************//**
  \brief Declaration of CalculateAuthenticParamsConf primitive parameters structure.
******************************************************************************/
typedef struct
{
  //! Calculated MacTag1 or MacTag2.
  uint8_t macTag[HASH_SIZE];
} SSP_CalculateAuthenticParamsConf_t;

/**************************************************************************//**
  \brief Declaration of CalculateAuthenticParamsConf primitive parameters structure.
******************************************************************************/
typedef struct
{
  //! Service field - for internal needs.
  SSP_Service_t service;
  //! Extended address of the device which initiated authnetication procedure.
  const uint64_t *initiatorIEEEAddr;
  //! Extended address of the device which should response.
  const uint64_t *responderIEEEAddr;
  //! Initiator or responder device frame counter.
  uint32_t frameCounter;
  //! Preset key which should be known by both devices (initiator and responder).
  const uint8_t *networkKey/*[SECURITY_KEY_SIZE]*/;
  //! Initiator challenge sequence (just 128-bit random number).
  uint8_t *qeu;
  //! Responder challenge sequence (just 128-bit random number).
  uint8_t *qev;
  //! Security Service Provider CalculateAuthenticParams confirm callback function's pointer.
  void (*SSP_CalculateAuthenticParamsConf)(SSP_CalculateAuthenticParamsConf_t *conf);
  //! Security Service Provider CalculateAuthenticParams confirm parameters' structure.
  SSP_CalculateAuthenticParamsConf_t confirm;
} SSP_CalculateAuthenticParamsReq_t;

/******************************************************************************
                        Prototypes section.
******************************************************************************/
/*******************************************************************************
  Performs calculation of the parameters for Mutual Symmetric-Key Entity
  Authentication procedure (MatTag1).
  Parameters:
    param - procedure parameters (for detailed description look at
             SSP_CalculateAuthenticParamsReq_t declaration).
  Return:
    none.
********************************************************************************/
void SSP_CalculateAuthenticMacTag1Req(SSP_CalculateAuthenticParamsReq_t *param);

/*******************************************************************************
  Performs calculation of the parameters for Mutual Symmetric-Key Entity
  Authentication procedure (MatTag2).
  Parameters:
    param - procedure parameters (for detailed description look at
             SSP_CalculateAuthenticParamsReq_t declaration).
  Return:
    none.
********************************************************************************/
void SSP_CalculateAuthenticMacTag2Req(SSP_CalculateAuthenticParamsReq_t *param);

#endif // _LINK_SECURITY_ 

#endif //_SSPAUTHENTIC_H

// eof sspAuthentic.h