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
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
/*******************************************************************************
OpenAirInterface
Copyright(c) 1999 - 2014 Eurecom
OpenAirInterface is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
OpenAirInterface is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with OpenAirInterface.The full GNU General Public License is
included in this distribution in the file called "COPYING". If not,
see <http://www.gnu.org/licenses/>.
Contact Information
OpenAirInterface Admin: openair_admin@eurecom.fr
OpenAirInterface Tech : openair_tech@eurecom.fr
OpenAirInterface Dev : openair4g-devel@eurecom.fr
Address : Eurecom, Compus SophiaTech 450, route des chappes, 06451 Biot, France.
*******************************************************************************/
/*****************************************************************************
Source LowerLayer.c
Version 0.1
Date 2012/03/14
Product NAS stack
Subsystem EPS Mobility Management
Author Frederic Maurel
Description Defines EMM procedures executed by the Non-Access Stratum
upon receiving notifications from lower layers so that data
transfer succeed or failed, or NAS signalling connection is
released, or ESM unit data has been received from under layer,
and to request ESM unit data transfer to under layer.
*****************************************************************************/
#include "LowerLayer.h"
#include "commonDef.h"
#include "nas_log.h"
#include "emmData.h"
#include "emm_sap.h"
#include "esm_sap.h"
#include "nas_log.h"
#include <string.h> // memset
/****************************************************************************/
/**************** E X T E R N A L D E F I N I T I O N S ****************/
/****************************************************************************/
/****************************************************************************/
/******************* L O C A L D E F I N I T I O N S *******************/
/****************************************************************************/
/****************************************************************************/
/****************** E X P O R T E D F U N C T I O N S ******************/
/****************************************************************************/
/*
* --------------------------------------------------------------------------
* Lower layer notification handlers
* --------------------------------------------------------------------------
*/
/****************************************************************************
** **
** Name: lowerlayer_success() **
** **
** Description: Notify the EPS Mobility Management entity that data have **
** been successfully delivered to the network **
** **
** Inputs: ueid: UE lower layer identifier **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_success(unsigned int ueid)
{
LOG_FUNC_IN;
emm_sap_t emm_sap;
int rc;
emm_sap.primitive = EMMREG_LOWERLAYER_SUCCESS;
emm_sap.u.emm_reg.ueid = ueid;
emm_sap.u.emm_reg.ctx = NULL;
rc = emm_sap_send(&emm_sap);
LOG_FUNC_RETURN (rc);
}
/****************************************************************************
** **
** Name: lowerlayer_failure() **
** **
** Description: Notify the EPS Mobility Management entity that lower la- **
** yers failed to deliver data to the network **
** **
** Inputs: ueid: UE lower layer identifier **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_failure(unsigned int ueid)
{
LOG_FUNC_IN;
emm_sap_t emm_sap;
int rc;
emm_sap.primitive = EMMREG_LOWERLAYER_FAILURE;
emm_sap.u.emm_reg.ueid = ueid;
#if defined(NAS_BUILT_IN_EPC)
emm_data_context_t *emm_ctx = NULL;
if (ueid > 0) {
emm_ctx = emm_data_context_get(&_emm_data, ueid);
}
emm_sap.u.emm_reg.ctx = emm_ctx;
#else
emm_sap.u.emm_reg.ctx = NULL;
#endif
rc = emm_sap_send(&emm_sap);
LOG_FUNC_RETURN (rc);
}
/****************************************************************************
** **
** Name: lowerlayer_establish() **
** **
** Description: Update the EPS connection management status upon recei- **
** ving indication so that the NAS signalling connection is **
** established **
** **
** Inputs: None **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_establish(void)
{
LOG_FUNC_IN;
LOG_FUNC_RETURN (RETURNok);
}
/****************************************************************************
** **
** Name: lowerlayer_release() **
** **
** Description: Notify the EPS Mobility Management entity that NAS signal-**
** ling connection has been released **
** **
** Inputs: cause: Release cause **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_release(int cause)
{
LOG_FUNC_IN;
emm_sap_t emm_sap;
int rc;
emm_sap.primitive = EMMREG_LOWERLAYER_RELEASE;
emm_sap.u.emm_reg.ueid = 0;
emm_sap.u.emm_reg.ctx = NULL;
rc = emm_sap_send(&emm_sap);
LOG_FUNC_RETURN (rc);
}
/****************************************************************************
** **
** Name: lowerlayer_data_ind() **
** **
** Description: Notify the EPS Session Management entity that data have **
** been received from lower layers **
** **
** Inputs: ueid: UE lower layer identifier **
** data: Data transfered from lower layers **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_data_ind(unsigned int ueid, const OctetString *data)
{
esm_sap_t esm_sap;
int rc;
emm_data_context_t *emm_ctx = NULL;
LOG_FUNC_IN;
#if defined(NAS_BUILT_IN_EPC)
if (ueid > 0) {
emm_ctx = emm_data_context_get(&_emm_data, ueid);
}
#endif
esm_sap.primitive = ESM_UNITDATA_IND;
esm_sap.is_standalone = TRUE;
esm_sap.ueid = ueid;
esm_sap.ctx = emm_ctx;
esm_sap.recv = data;
rc = esm_sap_send(&esm_sap);
LOG_FUNC_RETURN (rc);
}
/****************************************************************************
** **
** Name: lowerlayer_data_req() **
** **
** Description: Notify the EPS Mobility Management entity that data have **
** to be transfered to lower layers **
** **
** Inputs: ueid: UE lower layer identifier **
** data: Data to be transfered to lower layers **
** Others: None **
** **
** Outputs: None **
** Return: RETURNok, RETURNerror **
** Others: None **
** **
***************************************************************************/
int lowerlayer_data_req(unsigned int ueid, const OctetString *data)
{
LOG_FUNC_IN;
int rc;
emm_sap_t emm_sap;
emm_security_context_t *sctx = NULL;
struct emm_data_context_s *ctx = NULL;
emm_sap.primitive = EMMAS_DATA_REQ;
emm_sap.u.emm_as.u.data.guti = NULL;
emm_sap.u.emm_as.u.data.ueid = ueid;
# if defined(NAS_BUILT_IN_EPC)
if (ueid > 0) {
ctx = emm_data_context_get(&_emm_data, ueid);
}
# else
if (ueid < EMM_DATA_NB_UE_MAX) {
ctx = _emm_data.ctx[ueid];
}
# endif
if (ctx) {
sctx = ctx->security;
}
emm_sap.u.emm_as.u.data.NASinfo = 0;
emm_sap.u.emm_as.u.data.NASmsg.length = data->length;
emm_sap.u.emm_as.u.data.NASmsg.value = data->value;
/* Setup EPS NAS security data */
emm_as_set_security_data(&emm_sap.u.emm_as.u.data.sctx, sctx, FALSE, TRUE);
rc = emm_sap_send(&emm_sap);
LOG_FUNC_RETURN (rc);
}
/*
* --------------------------------------------------------------------------
* EMM procedure handlers
* --------------------------------------------------------------------------
*/
/****************************************************************************
** **
** Name: emm_as_set_security_data() **
** **
** Description: Setup security data according to the given EPS security **
** context when data transfer to lower layers is requested **
** **
** Inputs: args: EPS security context currently in use **
** is_new: Indicates whether a new security context **
** has just been taken into use **
** is_ciphered: Indicates whether the NAS message has to **
** be sent ciphered **
** Others: None **
** **
** Outputs: data: EPS NAS security data to be setup **
** Return: None **
** Others: None **
** **
***************************************************************************/
void emm_as_set_security_data(emm_as_security_data_t *data, const void *args,
int is_new, int is_ciphered)
{
LOG_FUNC_IN;
const emm_security_context_t *context = (emm_security_context_t *)(args);
memset(data, 0, sizeof(emm_as_security_data_t));
if ( context && (context->type != EMM_KSI_NOT_AVAILABLE) ) {
/* 3GPP TS 24.301, sections 5.4.3.3 and 5.4.3.4
* Once a valid EPS security context exists and has been taken
* into use, UE and MME shall cipher and integrity protect all
* NAS signalling messages with the selected NAS ciphering and
* NAS integrity algorithms */
LOG_TRACE(INFO,
"EPS security context exists is new %u KSI %u SQN %u count %u",
is_new,
context->eksi,
context->ul_count.seq_num,
*(uint32_t *)(&context->ul_count));
LOG_TRACE(INFO,
"knas_int %s",dump_octet_string(&context->knas_int));
LOG_TRACE(INFO,
"knas_enc %s",dump_octet_string(&context->knas_enc));
LOG_TRACE(INFO,
"kasme %s",dump_octet_string(&context->kasme));
data->is_new = is_new;
data->ksi = context->eksi;
data->sqn = context->dl_count.seq_num;
// LG data->count = *(uint32_t *)(&context->ul_count);
data->count = 0x00000000 | (context->dl_count.overflow << 8 ) | context->dl_count.seq_num;
/* NAS integrity and cyphering keys may not be available if the
* current security context is a partial EPS security context
* and not a full native EPS security context */
data->k_int = &context->knas_int;
if (is_ciphered) {
/* 3GPP TS 24.301, sections 4.4.5
* When the UE establishes a new NAS signalling connection,
* it shall send initial NAS messages integrity protected
* and unciphered */
/* 3GPP TS 24.301, section 5.4.3.2
* The MME shall send the SECURITY MODE COMMAND message integrity
* protected and unciphered */
LOG_TRACE(WARNING,
"EPS security context exists knas_enc");
data->k_enc = &context->knas_enc;
}
} else {
LOG_TRACE(WARNING, "EMM_AS_NO_KEY_AVAILABLE");
/* No valid EPS security context exists */
data->ksi = EMM_AS_NO_KEY_AVAILABLE;
}
LOG_FUNC_OUT;
}
/****************************************************************************/
/********************* L O C A L F U N C T I O N S *********************/
/****************************************************************************/