summaryrefslogtreecommitdiff
path: root/cp2/cco/action/action.h
blob: 3d2247394aecd4ed812fb734bf80c9effa488290 (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
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#ifndef cp_cco_action_action_h
#define cp_cco_action_action_h
/* Cesar project {{{
 *
 * Copyright (C) 2008 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    cp/cco/action/action.h
 * \brief   actions of CCo responsability 
 * \ingroup cp_cco
 *
 * CCo action module implements actions of CCo responsability
 * manage SNID "collisions" (if SNID conflict, a new SNID value shall be chosen) 
 * manage TEI leases (create, suppress, expire)
 * manage sta association
 * manage authentication with relevant keys (NEK, NMK) and security-level
 * in 1st step/version, each sta generates the default NMK from own NPW
 * (the NMK is used to belong to a given AVLN where all STAs and the CCo
 * have the same NMK) and the CCo in a given AVLN generates a NEK key
 * and sends it to stations which perform authentication steps.
 * 
 * Initialisation of SNID & management of SNID conflicts (section 4.4.1.4 in HP_AV spec)
 * Le SNID est prévu comme étant une représentation "raccourcie" du NID d'un AVLN
 * devant également permettre de faire la distinction entre 2 AVLNs ayant des NMKs
 * respectives différentes mais qui auraient un NID identique (un NID étant
 * obtenu par hachage SHA256 de NMK, le hachage de 2 NMKs différentes peut
 * produire un même NID, même si ce cas de figure est statistiquement improbable).
 * Dans le cas d'un NID identique pour 2 AVLNs ayant chacun une NMK respective
 * différente de celle de l'autre AVLN, il faut alors un SNID différent pour chacun
 * des 2 AVLNs.
 * Une CCo "1" qui détecterait un SNID identique au sien (arrivée d'un Central Beacon
 * d'une autre CCo "2", donc d'un autre AVLN, avec SNID identique) doit choisir
 * un autre SNID.
 * Le SNID qui était en double doit être marqué comme utilisé et la CCo "1" peut
 * finalement choisir une autre valeur de SNID parmi les SNIDs non utilisés
 * sur les 16 SNIDs possibles (le SNID est un entier sur 4 bits).
 * Le choix initial du SNID lorsqu'une station (un équipement) HP_AV s'initialise
 * puis passe à l'état "Unassociated CCo" ou "CCo" sera un tirage aléatoire entre
 * 0 inclus et 15 inclus, ce qui permet de diminuer le risque de doublon de SNID
 * entre les UCCo et CCo sur le même réseau Power-Line au démarrage (mise en route
 * du secteur avec des équipements fixes connectés, ou branchement d'un ou plusieurs
 * nouveaux équipements configurés avec un NPW différent de celui des autres équipements
 * déjà présents, par exemple)
 * La valeur initiale du SNID ou une nouvelle valeur du SNID déterminée/choisie
 * après détection d'un conflit de SNID doit être recopiée dans la structure
 * mac_config pour être rendue disponible dans les couches du Data-Plane qui
 * utilisent le SNID. Un mécanisme approprié d'activation temporisée d'une nouvelle
 * valeur du SNID soit être prévu
 */

BEGIN_DECLS

/**
 * initialisation of CCo action module.
 * 
 * \param  ctx  control plane context 
 */
void
cp_cco_action_init(cp_t *ctx);

/**
 * initialisation of "SNID in use" flags.
 * 
 * \param  ctx  control plane context 
 */
void
cp_cco_action_reset_snid_flags(cp_t *ctx);

/**
 * check against SNID conflict.
 * 
 * \param  ctx  control plane context
 * 
 * \return  true  if SNID conflict, else false
 * 
 * if the SNID value in argument is in conflict, it is flagged
 * as already used in the SNID flags
 */
bool
cp_cco_action_check_snid_conflict(cp_t *ctx, snid_t snid);

/**
 * choose a new SNID value.
 * 
 * \param  ctx  control plane context
 * \param  p_snid  pointer to return new snid value chosen
 * 
 * \return  false  if new SNID could not be chosen, else true
 * 
 * \todo  what to do if new SNID could not be chosen?
 * 
 * WARNING La valeur initiale du SNID ou une nouvelle valeur du SNID déterminée/choisie
 * après détection d'un conflit de SNID doit être recopiée dans la structure
 * mac_config pour être rendue disponible dans les couches du Data-Plane qui
 * utilisent le SNID. Un mécanisme approprié d'activation temporisée d'une nouvelle
 * valeur du SNID soit être prévu
 */
bool
cp_cco_action_choose_new_snid(cp_t *ctx, snid_t *p_snid);


/**
 * get a (first) random SNID value.
 * 
 * \param  ctx  control plane context
 * 
 * \return  random SNID value between 0 and 15
 * 
 * WARNING La valeur initiale du SNID doit être recopiée dans la structure
 * mac_config pour être rendue disponible dans les couches du Data-Plane qui
 * utilisent le SNID.
 */
snid_t
cp_cco_action_get_random_snid(cp_t *ctx);

/**
 * create a TEI lease.
 * 
 * \param  ctx  control plane context
 * \param  p_tei  pointer to return new TEI lease
 *  
 * \return  false  if TEI lease creation failed, else true 
 */
bool
cp_cco_action_create_tei_lease(cp_t *ctx, tei_t *p_tei);

/**
 * check for TEI lease expiration.
 * 
 * \param  ctx  control plane context
 * \param  p_tei  pointer to TEI lease to be checked
 *  
 * \return  true  if TEI lease expired, else false 
 */
bool
cp_cco_action_check_tei_lease(cp_t *ctx, tei_t *p_tei);

/**
 * remove a TEI lease.
 * 
 * \param  ctx  control plane context
 * \param  p_tei  pointer to TEI lease to be removed
 *  
 * \return  false  if removing TEI lease failed, else true 
 */
bool
cp_cco_action_remove_tei_lease(cp_t *ctx, tei_t *p_tei);

/**
 * generate a new NEK value.
 * 
 * \param  ctx  control plane context
 * \param  sl  security level
 * 
 * \return  generated nek value
 */
nek_t
cp_cco_action_gen_nek(cp_t *ctx, u8 sl);

/**
 * manage association of a station.
 * 
 * \param  ctx  control plane context
 */
void cp_cco_action_manage_sta_assoc(cp_t *ctx);

/**
 * manage authentication of a station.
 * 
 * \param  ctx  control plane context
 */
void cp_cco_action_manage_sta_auth(cp_t *ctx);

END_DECLS
  
#endif /* cp_cco_action_action_h */