SecurityModeControl.c 50.7 KB
Newer Older
Lionel Gauthier's avatar
Lionel Gauthier committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
/*******************************************************************************
    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
Cedric Roux's avatar
 
Cedric Roux committed
25

Lionel Gauthier's avatar
Lionel Gauthier committed
26 27 28 29
  Address      : Eurecom, Compus SophiaTech 450, route des chappes, 06451 Biot, France.

 *******************************************************************************/
/*****************************************************************************
Cedric Roux's avatar
Cedric Roux committed
30
Source      SecurityModeControl.c
Cedric Roux's avatar
 
Cedric Roux committed
31

Cedric Roux's avatar
Cedric Roux committed
32
Version     0.1
Cedric Roux's avatar
 
Cedric Roux committed
33

Cedric Roux's avatar
Cedric Roux committed
34
Date        2013/04/22
Cedric Roux's avatar
 
Cedric Roux committed
35

Cedric Roux's avatar
Cedric Roux committed
36
Product     NAS stack
Cedric Roux's avatar
 
Cedric Roux committed
37

Cedric Roux's avatar
Cedric Roux committed
38
Subsystem   Template body file
Cedric Roux's avatar
 
Cedric Roux committed
39

Cedric Roux's avatar
Cedric Roux committed
40
Author      Frederic Maurel
Cedric Roux's avatar
 
Cedric Roux committed
41

Cedric Roux's avatar
Cedric Roux committed
42 43
Description Defines the security mode control EMM procedure executed by the
        Non-Access Stratum.
Cedric Roux's avatar
 
Cedric Roux committed
44

Cedric Roux's avatar
Cedric Roux committed
45 46 47 48
        The purpose of the NAS security mode control procedure is to
        take an EPS security context into use, and initialise and start
        NAS signalling security between the UE and the MME with the
        corresponding EPS NAS keys and EPS security algorithms.
Cedric Roux's avatar
 
Cedric Roux committed
49

Cedric Roux's avatar
Cedric Roux committed
50 51 52
        Furthermore, the network may also initiate a SECURITY MODE COM-
        MAND in order to change the NAS security algorithms for a cur-
        rent EPS security context already in use.
Cedric Roux's avatar
 
Cedric Roux committed
53 54 55

*****************************************************************************/

56 57 58 59
#include <stdlib.h> // malloc, free
#include <string.h> // memcpy
#include <inttypes.h>

Cedric Roux's avatar
 
Cedric Roux committed
60 61 62 63 64 65 66 67 68
#include "emm_proc.h"
#include "nas_log.h"
#include "nas_timer.h"

#include "emmData.h"

#include "emm_sap.h"
#include "emm_cause.h"

69
#include "UeSecurityCapability.h"
70 71 72 73

#if defined(ENABLE_ITTI)
# include "assertions.h"
#endif
74
#include "secu_defs.h"
Cedric Roux's avatar
 
Cedric Roux committed
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89

/****************************************************************************/
/****************  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  *******************/
/****************************************************************************/

/*
 * --------------------------------------------------------------------------
 *  Internal data handled by the security mode control procedure in the UE
 * --------------------------------------------------------------------------
 */
#ifdef NAS_UE
Cedric Roux's avatar
Cedric Roux committed
90 91
static int _security_kdf(const OctetString *kasme, OctetString *key,
                         UInt8_t algo_dist, UInt8_t algo_id);
Cedric Roux's avatar
 
Cedric Roux committed
92

Cedric Roux's avatar
Cedric Roux committed
93 94 95 96 97 98
static int _security_knas_enc(const OctetString *kasme, OctetString *knas_enc,
                              UInt8_t eia);
static int _security_knas_int(const OctetString *kasme, OctetString *knas_int,
                              UInt8_t eea);
static int _security_kenb(const OctetString *kasme, OctetString *kenb,
                          UInt32_t count);
Cedric Roux's avatar
 
Cedric Roux committed
99 100 101 102 103

/*
 * Internal data used for security mode control procedure
 */
static struct {
Cedric Roux's avatar
Cedric Roux committed
104
    OctetString kenb;           /* eNodeB security key      */
Cedric Roux's avatar
 
Cedric Roux committed
105 106
} _security_data;

Cedric Roux's avatar
Cedric Roux committed
107 108
static void _security_release(emm_security_context_t *ctx);
#endif  // NAS_UE
Cedric Roux's avatar
 
Cedric Roux committed
109 110 111 112 113 114 115 116 117 118

/*
 * --------------------------------------------------------------------------
 *  Internal data handled by the security mode control procedure in the MME
 * --------------------------------------------------------------------------
 */
#ifdef NAS_MME
/*
 * Timer handlers
 */
Cedric Roux's avatar
Cedric Roux committed
119
static void *_security_t3460_handler(void *);
Cedric Roux's avatar
 
Cedric Roux committed
120 121 122 123 124 125

/*
 * Function executed whenever the ongoing EMM procedure that initiated
 * the security mode control procedure is aborted or the maximum value of the
 * retransmission timer counter is exceed
 */
Cedric Roux's avatar
Cedric Roux committed
126
static int _security_abort(void *);
127 128 129 130 131
static int _security_select_algorithms(
    const int   ue_eiaP,
    const int   ue_eeaP,
    int * const mme_eiaP,
    int * const mme_eeaP);
Cedric Roux's avatar
 
Cedric Roux committed
132 133 134 135
/*
 * Internal data used for security mode control procedure
 */
typedef struct {
136
    unsigned int ueid;      /* UE identifier                       */
Cedric Roux's avatar
Cedric Roux committed
137 138
#define SECURITY_COUNTER_MAX    5
    unsigned int retransmission_count;  /* Retransmission counter   */
139 140 141
    int ksi;                /* NAS key set identifier               */
    int eea;                /* Replayed EPS encryption algorithms   */
    int eia;                /* Replayed EPS integrity algorithms    */
142 143
    int selected_eea;       /* Selected EPS encryption algorithms   */
    int selected_eia;       /* Selected EPS integrity algorithms    */
Cedric Roux's avatar
Cedric Roux committed
144
    int notify_failure;     /* Indicates whether the security mode control
145 146
                             * procedure failure shall be notified to the
                             * ongoing EMM procedure        */
Cedric Roux's avatar
 
Cedric Roux committed
147 148
} security_data_t;

Cedric Roux's avatar
Cedric Roux committed
149
static int _security_request(security_data_t *data, int is_new);
Cedric Roux's avatar
 
Cedric Roux committed
150 151 152 153 154 155 156 157
#endif // NAS_MME

/****************************************************************************/
/******************  E X P O R T E D    F U N C T I O N S  ******************/
/****************************************************************************/

/*
 * --------------------------------------------------------------------------
Cedric Roux's avatar
Cedric Roux committed
158
 *      Security mode control procedure executed by the UE
Cedric Roux's avatar
 
Cedric Roux committed
159 160 161 162 163
 * --------------------------------------------------------------------------
 */
#ifdef NAS_UE
/****************************************************************************
 **                                                                        **
Lionel Gauthier's avatar
Lionel Gauthier committed
164
 ** Name:    emm_proc_security_mode_command()                              **
Cedric Roux's avatar
 
Cedric Roux committed
165 166
 **                                                                        **
 ** Description: Performs the MME requested security mode control proce-   **
Lionel Gauthier's avatar
Lionel Gauthier committed
167
 **      dure.                                                             **
Cedric Roux's avatar
 
Cedric Roux committed
168 169
 **                                                                        **
 **              3GPP TS 24.301, section 5.4.3.3                           **
Lionel Gauthier's avatar
Lionel Gauthier committed
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
 **      Upon receiving the SECURITY MODE COMMAND message, the UE          **
 **      shall check whether the message can be accepted or not.           **
 **      If accepted the UE shall send a SECURITY MODE COMPLETE            **
 **      message integrity protected with the selected NAS inte-           **
 **      grity algorithm and ciphered with the selected NAS ciphe-         **
 **      ring algorithm.                                                   **
 **                                                                        **
 ** Inputs:  native_ksi:    TRUE if the security context is of type        **
 **             native (for KSIASME)                                       **
 **      ksi:       The NAS ket sey identifier                             **
 **      seea:      Selected EPS cyphering algorithm                       **
 **      seia:      Selected EPS integrity algorithm                       **
 **      reea:      Replayed EPS cyphering algorithm                       **
 **      reia:      Replayed EPS integrity algorithm                       **
 **      Others:    None                                                   **
Cedric Roux's avatar
Cedric Roux committed
185 186
 **                                                                        **
 ** Outputs:     None                                                      **
Lionel Gauthier's avatar
Lionel Gauthier committed
187 188
 **      Return:    RETURNok, RETURNerror                                  **
 **      Others:    None                                                   **
Cedric Roux's avatar
 
Cedric Roux committed
189 190 191
 **                                                                        **
 ***************************************************************************/
int emm_proc_security_mode_command(int native_ksi, int ksi,
Cedric Roux's avatar
Cedric Roux committed
192
                                   int seea, int seia, int reea, int reia)
Cedric Roux's avatar
 
Cedric Roux committed
193 194 195 196 197 198 199 200
{
    LOG_FUNC_IN;

    int rc = RETURNerror;
    int emm_cause = EMM_CAUSE_SUCCESS;
    int security_context_is_new = FALSE;

    LOG_TRACE(INFO, "EMM-PROC  - Security mode control requested (ksi=%d)",
Cedric Roux's avatar
Cedric Roux committed
201
              ksi);
Cedric Roux's avatar
 
Cedric Roux committed
202 203 204 205 206 207 208 209 210 211

    /* Delete any previously stored RAND and RES and stop timer T3416 */
    (void) emm_proc_authentication_delete();

    /*
     * Check the replayed UE security capabilities
     */
    UInt8_t eea = (0x80 >> _emm_data.security->capability.encryption);
    UInt8_t eia = (0x80 >> _emm_data.security->capability.integrity);
    if ( (reea != eea) || (reia != eia) ) {
Cedric Roux's avatar
Cedric Roux committed
212 213 214 215 216 217 218 219 220
        LOG_TRACE(WARNING, "EMM-PROC  - Replayed UE security capabilities "
                  "rejected");
        emm_cause = EMM_CAUSE_UE_SECURITY_MISMATCH;

        /* XXX - For testing purpose UE always accepts EIA0
         * The UE shall accept "null integrity protection algorithm" EIA0 only
         * if a PDN connection for emergency bearer services is established or
         * the UE is establishing a PDN connection for emergency bearer services
         */
Cedric Roux's avatar
 
Cedric Roux committed
221 222 223 224 225
    }
    /*
     * Check the non-current EPS security context
     */
    else if (_emm_data.non_current == NULL) {
Cedric Roux's avatar
Cedric Roux committed
226 227 228
        LOG_TRACE(WARNING, "EMM-PROC  - Non-current EPS security context "
                  "is not valid");
        emm_cause = EMM_CAUSE_SECURITY_MODE_REJECTED;
Cedric Roux's avatar
 
Cedric Roux committed
229 230 231 232 233
    }
    /*
     * Update the non-current EPS security context
     */
    else {
Lionel Gauthier's avatar
Lionel Gauthier committed
234
        LOG_TRACE(INFO, "EMM-PROC  - Update the non-current EPS security context seea=%u seia=%u", seea, seia);
Cedric Roux's avatar
Cedric Roux committed
235 236
        /* Update selected cyphering and integrity algorithms */
        _emm_data.non_current->capability.encryption = seea;
237
        _emm_data.non_current->capability.integrity  = seia;
Cedric Roux's avatar
Cedric Roux committed
238 239 240 241

        /* Derive the NAS cyphering key */
        if (_emm_data.non_current->knas_enc.value == NULL) {
            _emm_data.non_current->knas_enc.value =
242
                (uint8_t *)calloc(1,AUTH_KNAS_ENC_SIZE);
Cedric Roux's avatar
Cedric Roux committed
243 244 245
            _emm_data.non_current->knas_enc.length = AUTH_KNAS_ENC_SIZE;
        }
        if (_emm_data.non_current->knas_enc.value != NULL) {
Lionel Gauthier's avatar
Lionel Gauthier committed
246
            LOG_TRACE(INFO, "EMM-PROC  - Update the non-current EPS security context knas_enc");
Cedric Roux's avatar
Cedric Roux committed
247 248 249 250 251 252
            rc = _security_knas_enc(&_emm_data.non_current->kasme,
                                    &_emm_data.non_current->knas_enc, seea);
        }
        /* Derive the NAS integrity key */
        if (_emm_data.non_current->knas_int.value == NULL) {
            _emm_data.non_current->knas_int.value =
253
                (uint8_t *)calloc(1,AUTH_KNAS_INT_SIZE);
Cedric Roux's avatar
Cedric Roux committed
254 255 256 257
            _emm_data.non_current->knas_int.length = AUTH_KNAS_INT_SIZE;
        }
        if (_emm_data.non_current->knas_int.value != NULL) {
            if (rc != RETURNerror) {
Lionel Gauthier's avatar
Lionel Gauthier committed
258
                LOG_TRACE(INFO, "EMM-PROC  - Update the non-current EPS security context knas_int");
Cedric Roux's avatar
Cedric Roux committed
259
                rc = _security_knas_int(&_emm_data.non_current->kasme,
260
                                        &_emm_data.non_current->knas_int, seia);
Cedric Roux's avatar
Cedric Roux committed
261 262 263 264
            }
        }
        /* Derive the eNodeB key */
        if (_security_data.kenb.value == NULL) {
265
            _security_data.kenb.value = (uint8_t *)calloc(1,AUTH_KENB_SIZE);
Cedric Roux's avatar
Cedric Roux committed
266 267 268 269
            _security_data.kenb.length = AUTH_KENB_SIZE;
        }
        if (_security_data.kenb.value != NULL) {
            if (rc != RETURNerror) {
Lionel Gauthier's avatar
Lionel Gauthier committed
270
                LOG_TRACE(INFO, "EMM-PROC  - Update the non-current EPS security context kenb");
271 272 273
                // LG COMMENT rc = _security_kenb(&_emm_data.security->kasme,
                rc = _security_kenb(&_emm_data.non_current->kasme,
                					&_security_data.kenb,
Cedric Roux's avatar
Cedric Roux committed
274 275 276 277 278 279 280 281
                                    *(UInt32_t *)(&_emm_data.non_current->ul_count));
            }
        }

        /*
         * NAS security mode command accepted by the UE
         */
        if (rc != RETURNerror) {
Lionel Gauthier's avatar
Lionel Gauthier committed
282
            LOG_TRACE(INFO, "EMM-PROC  - NAS security mode command accepted by the UE");
Cedric Roux's avatar
Cedric Roux committed
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
            /* Update the current EPS security context */
            if ( native_ksi && (_emm_data.security->type != EMM_KSI_NATIVE) ) {
                /* The type of security context flag included in the SECURITY
                 * MODE COMMAND message is set to "native security context" and
                 * the UE has a mapped EPS security context as the current EPS
                 * security context */
                if ( (_emm_data.non_current->type == EMM_KSI_NATIVE) &&
                        (_emm_data.non_current->eksi == ksi) ) {
                    /* The KSI matches the non-current native EPS security
                     * context; the UE shall take the non-current native EPS
                     * security context into use which then becomes the
                     * current native EPS security context and delete the
                     * mapped EPS security context */
                    LOG_TRACE(INFO,
                              "EMM-PROC  - Update Current security context");
                    /* Release non-current security context */
                    _security_release(_emm_data.security);
                    _emm_data.security = _emm_data.non_current;
                    /* Reset the uplink NAS COUNT counter */
                    _emm_data.security->ul_count.overflow = 0;
                    _emm_data.security->ul_count.seq_num = 0;
                    /* Set new security context indicator */
                    security_context_is_new = TRUE;
                }
            }

            if ( !native_ksi && (_emm_data.security->type != EMM_KSI_NATIVE) ) {
                /* The type of security context flag included in the SECURITY
                 * MODE COMMAND message is set to "mapped security context" and
                 * the UE has a mapped EPS security context as the current EPS
                 * security context */
                if (ksi != _emm_data.security->eksi) {
                    /* The KSI does not match the current EPS security context;
                     * the UE shall reset the uplink NAS COUNT counter */
                    LOG_TRACE(INFO,
                              "EMM-PROC  - Reset uplink NAS COUNT counter");
                    _emm_data.security->ul_count.overflow = 0;
                    _emm_data.security->ul_count.seq_num = 0;
                }
            }
323 324 325 326

            _emm_data.security->selected_algorithms.encryption = seea;
            _emm_data.security->selected_algorithms.integrity  = seia;

Cedric Roux's avatar
Cedric Roux committed
327 328 329 330 331 332 333 334 335 336 337 338 339 340
        }
        /*
         * NAS security mode command not accepted by the UE
         */
        else {
            /* Setup EMM cause code */
            emm_cause = EMM_CAUSE_SECURITY_MODE_REJECTED;
            /* Release security mode control internal data */
            if (_security_data.kenb.value) {
                free(_security_data.kenb.value);
                _security_data.kenb.value = NULL;
                _security_data.kenb.length = 0;
            }
        }
Cedric Roux's avatar
 
Cedric Roux committed
341 342 343 344 345 346
    }

    /* Setup EMM procedure handler to be executed upon receiving
     * lower layer notification */
    rc = emm_proc_lowerlayer_initialize(NULL, NULL, NULL, NULL);
    if (rc != RETURNok) {
Cedric Roux's avatar
Cedric Roux committed
347 348 349
        LOG_TRACE(WARNING,
                  "EMM-PROC  - Failed to initialize EMM procedure handler");
        LOG_FUNC_RETURN (RETURNerror);
Cedric Roux's avatar
 
Cedric Roux committed
350 351 352 353 354 355 356 357 358 359 360 361 362 363
    }

    /*
     * Notify EMM-AS SAP that Security Mode response message has to be sent
     * to the network
     */
    emm_sap_t emm_sap;
    emm_sap.primitive = EMMAS_SECURITY_RES;
    emm_sap.u.emm_as.u.security.guti = _emm_data.guti;
    emm_sap.u.emm_as.u.security.ueid = 0;
    emm_sap.u.emm_as.u.security.msgType = EMM_AS_MSG_TYPE_SMC;
    emm_sap.u.emm_as.u.security.emm_cause = emm_cause;
    /* Setup EPS NAS security data */
    emm_as_set_security_data(&emm_sap.u.emm_as.u.security.sctx,
Cedric Roux's avatar
Cedric Roux committed
364
                             _emm_data.security, security_context_is_new, TRUE);
Cedric Roux's avatar
 
Cedric Roux committed
365 366 367 368 369 370 371 372
    rc = emm_sap_send(&emm_sap);

    LOG_FUNC_RETURN (rc);
}
#endif // NAS_UE

/*
 * --------------------------------------------------------------------------
Cedric Roux's avatar
Cedric Roux committed
373
 *      Security mode control procedure executed by the MME
Cedric Roux's avatar
 
Cedric Roux committed
374 375 376
 * --------------------------------------------------------------------------
 */
#ifdef NAS_MME
377 378


Cedric Roux's avatar
 
Cedric Roux committed
379 380
/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
381
 ** Name:    emm_proc_security_mode_control()                          **
Cedric Roux's avatar
 
Cedric Roux committed
382 383 384 385
 **                                                                        **
 ** Description: Initiates the security mode control procedure.            **
 **                                                                        **
 **              3GPP TS 24.301, section 5.4.3.2                           **
Cedric Roux's avatar
Cedric Roux committed
386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
 **      The MME initiates the NAS security mode control procedure **
 **      by sending a SECURITY MODE COMMAND message to the UE and  **
 **      starting timer T3460. The message shall be sent unciphe-  **
 **      red but shall be integrity protected using the NAS inte-  **
 **      grity key based on KASME.                                 **
 **                                                                        **
 ** Inputs:  ueid:      UE lower layer identifier                  **
 **      ksi:       NAS key set identifier                     **
 **      eea:       Replayed EPS encryption algorithms         **
 **      eia:       Replayed EPS integrity algorithms          **
 **      success:   Callback function executed when the secu-  **
 **             rity mode control procedure successfully   **
 **             completes                                  **
 **      reject:    Callback function executed when the secu-  **
 **             rity mode control procedure fails or is    **
 **             rejected                                   **
 **      failure:   Callback function executed whener a lower  **
 **             layer failure occured before the security  **
 **             mode control procedure comnpletes          **
 **      Others:    None                                       **
 **                                                                        **
 ** Outputs:     None                                                      **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
410 411 412
 **                                                                        **
 ***************************************************************************/
int emm_proc_security_mode_control(unsigned int ueid, int ksi, int eea, int eia,
Cedric Roux's avatar
Cedric Roux committed
413 414 415
                                   emm_common_success_callback_t success,
                                   emm_common_reject_callback_t reject,
                                   emm_common_failure_callback_t failure)
Cedric Roux's avatar
 
Cedric Roux committed
416 417 418
{
    int rc = RETURNerror;
    int security_context_is_new = FALSE;
419 420
    int mme_eea                 = NAS_SECURITY_ALGORITHMS_EEA0;
    int mme_eia                 = NAS_SECURITY_ALGORITHMS_EIA0;
Cedric Roux's avatar
 
Cedric Roux committed
421
    /* Get the UE context */
Cedric Roux's avatar
Cedric Roux committed
422
    emm_data_context_t *emm_ctx = NULL;
Cedric Roux's avatar
 
Cedric Roux committed
423

424 425 426
    LOG_FUNC_IN;

    LOG_TRACE(INFO, "EMM-PROC  - Initiate security mode control procedure "
427 428
              "KSI = %d EEA = %d EIA = %d",
              ksi, eea, eia);
429

Cedric Roux's avatar
 
Cedric Roux committed
430 431 432 433 434 435 436 437 438 439 440
#if defined(EPC_BUILD)
    if (ueid > 0) {
        emm_ctx = emm_data_context_get(&_emm_data, ueid);
    }
#else
    if (ueid < EMM_DATA_NB_UE_MAX) {
        emm_ctx = _emm_data.ctx[ueid];
    }
#endif

    if (emm_ctx && emm_ctx->security) {
Cedric Roux's avatar
Cedric Roux committed
441 442 443 444 445 446 447 448 449 450
        if (emm_ctx->security->type == EMM_KSI_NOT_AVAILABLE) {
            /* The security mode control procedure is initiated to take into use
             * the EPS security context created after a successful execution of
             * the EPS authentication procedure */
            emm_ctx->security->type = EMM_KSI_NATIVE;
            emm_ctx->security->eksi = ksi;
            emm_ctx->security->dl_count.overflow = 0;
            emm_ctx->security->dl_count.seq_num = 0;

            /* TODO !!! Compute Kasme, and NAS cyphering and integrity keys */
451 452 453
            // LG: Kasme should have been received from authentication
            //     information request (S6A)
            // Kasme is located in emm_ctx->vector.kasme
454 455 456 457 458 459 460
            FREE_OCTET_STRING(emm_ctx->security->kasme);

            emm_ctx->security->kasme.value = malloc(32);
            memcpy(emm_ctx->security->kasme.value,
            	emm_ctx->vector.kasme,
            	32);
            emm_ctx->security->kasme.length = 32;
461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479

            rc = _security_select_algorithms(
                eia,
                eea,
                &mme_eia,
                &mme_eea);

            emm_ctx->security->selected_algorithms.encryption = mme_eea;
            emm_ctx->security->selected_algorithms.integrity  = mme_eia;

            if (rc == RETURNerror) {
                LOG_TRACE(WARNING,
                    "EMM-PROC  - Failed to select security algorithms");
                LOG_FUNC_RETURN (RETURNerror);
            }

            if ( ! emm_ctx->security->knas_int.value) {
                emm_ctx->security->knas_int.value = malloc(AUTH_KNAS_INT_SIZE);
            } else {
Lionel Gauthier's avatar
 
Lionel Gauthier committed
480
            	LOG_TRACE(ERROR,
481
                    " TODO realloc emm_ctx->security->knas_int OctetString");
Lionel Gauthier's avatar
 
Lionel Gauthier committed
482
                LOG_FUNC_RETURN (RETURNerror);
483 484 485 486 487 488
            }
            emm_ctx->security->knas_int.length = AUTH_KNAS_INT_SIZE;
            derive_key_nas(
                NAS_INT_ALG,
                emm_ctx->security->selected_algorithms.integrity,
                emm_ctx->vector.kasme,
489
                emm_ctx->security->knas_int.value);
490 491 492 493

            if ( ! emm_ctx->security->knas_enc.value) {
                emm_ctx->security->knas_enc.value = malloc(AUTH_KNAS_ENC_SIZE);
            } else {
Lionel Gauthier's avatar
 
Lionel Gauthier committed
494
            	LOG_TRACE(ERROR,
495
                    " TODO realloc emm_ctx->security->knas_enc OctetString");
Lionel Gauthier's avatar
 
Lionel Gauthier committed
496
                LOG_FUNC_RETURN (RETURNerror);
497 498 499 500 501 502
            }
            emm_ctx->security->knas_enc.length = AUTH_KNAS_ENC_SIZE;
            derive_key_nas(
                NAS_ENC_ALG,
                emm_ctx->security->selected_algorithms.encryption,
                emm_ctx->vector.kasme,
503
                emm_ctx->security->knas_enc.value);
Cedric Roux's avatar
Cedric Roux committed
504 505 506 507 508 509 510

            /* Set new security context indicator */
            security_context_is_new = TRUE;
        }
    } else {
        LOG_TRACE(WARNING, "EMM-PROC  - No EPS security context exists");
        LOG_FUNC_RETURN (RETURNerror);
Cedric Roux's avatar
 
Cedric Roux committed
511 512 513
    }

    /* Allocate parameters of the retransmission timer callback */
Cedric Roux's avatar
Cedric Roux committed
514 515
    security_data_t *data =
        (security_data_t *)malloc(sizeof(security_data_t));
Cedric Roux's avatar
 
Cedric Roux committed
516 517

    if (data != NULL) {
Cedric Roux's avatar
Cedric Roux committed
518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
        /* Setup ongoing EMM procedure callback functions */
        rc = emm_proc_common_initialize(ueid, success, reject, failure,
                                        _security_abort, data);
        if (rc != RETURNok) {
            LOG_TRACE(WARNING, "Failed to initialize EMM callback functions");
            free(data);
            LOG_FUNC_RETURN (RETURNerror);
        }
        /* Set the UE identifier */
        data->ueid = ueid;
        /* Reset the retransmission counter */
        data->retransmission_count = 0;
        /* Set the key set identifier */
        data->ksi = ksi;
        /* Set the EPS encryption algorithms to be replayed to the UE */
        data->eea = eea;
        /* Set the EPS integrity algorithms to be replayed to the UE */
        data->eia = eia;
536 537 538 539
        /* Set the EPS encryption algorithms to be replayed to the UE */
        data->selected_eea = emm_ctx->security->selected_algorithms.encryption;
        /* Set the EPS integrity algorithms to be replayed to the UE */
        data->selected_eia = emm_ctx->security->selected_algorithms.integrity;
Cedric Roux's avatar
Cedric Roux committed
540 541 542 543 544 545 546 547 548 549 550
        /* Set the failure notification indicator */
        data->notify_failure = FALSE;
        /* Send security mode command message to the UE */
        rc = _security_request(data, security_context_is_new);
        if (rc != RETURNerror) {
            /*
             * Notify EMM that common procedure has been initiated
             */
            emm_sap_t emm_sap;
            emm_sap.primitive = EMMREG_COMMON_PROC_REQ;
            emm_sap.u.emm_reg.ueid = ueid;
551
            emm_sap.u.emm_reg.ctx  = emm_ctx;
Cedric Roux's avatar
Cedric Roux committed
552 553
            rc = emm_sap_send(&emm_sap);
        }
Cedric Roux's avatar
 
Cedric Roux committed
554 555 556 557 558 559 560
    }

    LOG_FUNC_RETURN (rc);
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
561
 ** Name:    emm_proc_security_mode_complete()                         **
Cedric Roux's avatar
 
Cedric Roux committed
562 563
 **                                                                        **
 ** Description: Performs the security mode control completion procedure   **
Cedric Roux's avatar
Cedric Roux committed
564
 **      executed by the network.                                  **
Cedric Roux's avatar
 
Cedric Roux committed
565 566
 **                                                                        **
 **              3GPP TS 24.301, section 5.4.3.4                           **
Cedric Roux's avatar
Cedric Roux committed
567 568 569 570 571
 **      Upon receiving the SECURITY MODE COMPLETE message, the    **
 **      MME shall stop timer T3460.                               **
 **      From this time onward the MME shall integrity protect and **
 **      encipher all signalling messages with the selected NAS    **
 **      integrity and ciphering algorithms.                       **
Cedric Roux's avatar
 
Cedric Roux committed
572
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
573 574
 ** Inputs:  ueid:      UE lower layer identifier                  **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
575
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
576 577 578
 ** Outputs:     None                                                      **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
579 580 581 582
 **                                                                        **
 ***************************************************************************/
int emm_proc_security_mode_complete(unsigned int ueid)
{
Cedric Roux's avatar
Cedric Roux committed
583
    emm_data_context_t *emm_ctx = NULL;
Cedric Roux's avatar
 
Cedric Roux committed
584 585 586 587 588 589 590 591 592 593 594 595 596

    int rc = RETURNerror;
    emm_sap_t emm_sap;

    LOG_FUNC_IN;

    LOG_TRACE(INFO, "EMM-PROC  - Security mode complete (ueid=%u)", ueid);

    /* Stop timer T3460 */
    LOG_TRACE(INFO, "EMM-PROC  - Stop timer T3460 (%d)", T3460.id);
    T3460.id = nas_timer_stop(T3460.id);

    /* Release retransmission timer paramaters */
Cedric Roux's avatar
Cedric Roux committed
597 598 599 600
    security_data_t *data = (security_data_t *)(emm_proc_common_get_args(ueid));
    if (data) {
        free(data);
    }
Cedric Roux's avatar
 
Cedric Roux committed
601 602 603 604 605 606 607 608 609 610 611 612 613

    /* Get the UE context */
#if defined(EPC_BUILD)
    if (ueid > 0) {
        emm_ctx = emm_data_context_get(&_emm_data, ueid);
    }
#else
    if (ueid < EMM_DATA_NB_UE_MAX) {
        emm_ctx = _emm_data.ctx[ueid];
    }
#endif

    if (emm_ctx && emm_ctx->security) {
Cedric Roux's avatar
Cedric Roux committed
614 615 616 617 618
        /*
         * Notify EMM that the authentication procedure successfully completed
         */
        emm_sap.primitive = EMMREG_COMMON_PROC_CNF;
        emm_sap.u.emm_reg.ueid = ueid;
619
        emm_sap.u.emm_reg.ctx  = emm_ctx;
Cedric Roux's avatar
Cedric Roux committed
620 621 622 623 624 625 626 627
        emm_sap.u.emm_reg.u.common.is_attached = emm_ctx->is_attached;
    } else {
        LOG_TRACE(ERROR, "EMM-PROC  - No EPS security context exists");
        /*
         * Notify EMM that the authentication procedure failed
         */
        emm_sap.primitive = EMMREG_COMMON_PROC_REJ;
        emm_sap.u.emm_reg.ueid = ueid;
628
        emm_sap.u.emm_reg.ctx  = emm_ctx;
Cedric Roux's avatar
 
Cedric Roux committed
629 630 631 632 633 634 635 636 637
    }

    rc = emm_sap_send(&emm_sap);

    LOG_FUNC_RETURN (rc);
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
638
 ** Name:    emm_proc_security_mode_reject()                           **
Cedric Roux's avatar
 
Cedric Roux committed
639 640 641 642
 **                                                                        **
 ** Description: Performs the security mode control not accepted by the UE **
 **                                                                        **
 **              3GPP TS 24.301, section 5.4.3.5                           **
Cedric Roux's avatar
Cedric Roux committed
643 644 645 646 647 648 649
 **      Upon receiving the SECURITY MODE REJECT message, the MME  **
 **      shall stop timer T3460 and abort the ongoing procedure    **
 **      that triggered the initiation of the NAS security mode    **
 **      control procedure.                                        **
 **      The MME shall apply the EPS security context in use befo- **
 **      re the initiation of the security mode control procedure, **
 **      if any, to protect any subsequent messages.               **
Cedric Roux's avatar
 
Cedric Roux committed
650 651
 **                                                                        **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
652 653
 ** Inputs:  ueid:      UE lower layer identifier                  **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
654
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
655 656 657
 ** Outputs:     None                                                      **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
658 659 660 661
 **                                                                        **
 ***************************************************************************/
int emm_proc_security_mode_reject(unsigned int ueid)
{
Cedric Roux's avatar
Cedric Roux committed
662
    emm_data_context_t *emm_ctx = NULL;
Cedric Roux's avatar
 
Cedric Roux committed
663 664 665 666 667 668 669 670 671 672 673 674
    int rc = RETURNerror;

    LOG_FUNC_IN;

    LOG_TRACE(WARNING, "EMM-PROC  - Security mode command not accepted by the UE"
              "(ueid=0x%08x)", ueid);

    /* Stop timer T3460 */
    LOG_TRACE(INFO, "EMM-PROC  - Stop timer T3460 (%d)", T3460.id);
    T3460.id = nas_timer_stop(T3460.id);

    /* Release retransmission timer paramaters */
Cedric Roux's avatar
Cedric Roux committed
675 676 677 678
    security_data_t *data = (security_data_t *)(emm_proc_common_get_args(ueid));
    if (data) {
        free(data);
    }
Cedric Roux's avatar
 
Cedric Roux committed
679 680 681 682 683

    /* Get the UE context */
#if defined(EPC_BUILD)
    if (ueid > 0) {
        emm_ctx = emm_data_context_get(&_emm_data, ueid);
684
        DevAssert(emm_ctx != NULL);
Cedric Roux's avatar
 
Cedric Roux committed
685 686 687 688 689 690 691 692
    }
#else
    if (ueid < EMM_DATA_NB_UE_MAX) {
        emm_ctx = _emm_data.ctx[ueid];
    }
#endif
    /* Set the key set identifier to its previous value */
    if (emm_ctx && emm_ctx->security) {
Cedric Roux's avatar
Cedric Roux committed
693 694 695 696 697 698 699
        /* XXX - Usually, the MME should be able to maintain a current and
         * a non-current EPS security context simultaneously as the UE do.
         * This implementation choose to have only one security context by UE
         * in the MME, thus security mode control procedure is only performed
         * to take into use the first EPS security context created after a
         * successful execution of the EPS authentication procedure */
        emm_ctx->security->type = EMM_KSI_NOT_AVAILABLE;
Cedric Roux's avatar
 
Cedric Roux committed
700 701 702 703 704 705 706 707
    }

    /*
     * Notify EMM that the authentication procedure failed
     */
    emm_sap_t emm_sap;
    emm_sap.primitive = EMMREG_COMMON_PROC_REJ;
    emm_sap.u.emm_reg.ueid = ueid;
708
    emm_sap.u.emm_reg.ctx  = emm_ctx;
Cedric Roux's avatar
 
Cedric Roux committed
709 710 711 712 713 714 715 716 717 718 719 720 721
    rc = emm_sap_send(&emm_sap);

    LOG_FUNC_RETURN (rc);
}
#endif // NAS_MME

/****************************************************************************/
/*********************  L O C A L    F U N C T I O N S  *********************/
/****************************************************************************/

#ifdef NAS_UE
/*
 * --------------------------------------------------------------------------
Cedric Roux's avatar
Cedric Roux committed
722
 *              UE specific local functions
Cedric Roux's avatar
 
Cedric Roux committed
723 724 725 726 727
 * --------------------------------------------------------------------------
 */

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
728
 ** Name:    _security_release()                                       **
Cedric Roux's avatar
 
Cedric Roux committed
729 730 731
 **                                                                        **
 ** Description: Releases the given EPS NAS security context               **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
732 733
 ** Inputs:  ctx:       The EPS NAS security context to release    **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
734
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
735 736 737
 ** Outputs:     None                                                      **
 **      Return:    None                                       **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
738 739
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
740
static void _security_release(emm_security_context_t *ctx)
Cedric Roux's avatar
 
Cedric Roux committed
741 742 743 744
{
    LOG_FUNC_IN;

    if (ctx) {
Cedric Roux's avatar
Cedric Roux committed
745 746 747
        /* Release Kasme security key */
        if (ctx->kasme.value) {
            free(ctx->kasme.value);
748 749
            ctx->kasme.value  = NULL;
            ctx->kasme.length = 0;
Cedric Roux's avatar
Cedric Roux committed
750 751 752 753
        }
        /* Release NAS cyphering key */
        if (ctx->knas_enc.value) {
            free(ctx->knas_enc.value);
754 755
            ctx->knas_enc.value  = NULL;
            ctx->knas_enc.length = 0;
Cedric Roux's avatar
Cedric Roux committed
756 757 758 759
        }
        /* Release NAS integrity key */
        if (ctx->knas_int.value) {
            free(ctx->knas_int.value);
760 761
            ctx->knas_int.value  = NULL;
            ctx->knas_int.length = 0;
Cedric Roux's avatar
Cedric Roux committed
762 763 764
        }
        /* Release the NAS security context */
        free(ctx);
Cedric Roux's avatar
 
Cedric Roux committed
765 766 767 768 769 770 771
    }

    LOG_FUNC_OUT;
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
772
 ** Name:    _security_knas_enc()                                      **
Cedric Roux's avatar
 
Cedric Roux committed
773 774
 **                                                                        **
 ** Description: Algorithm Key generation function used for the derivation **
Cedric Roux's avatar
Cedric Roux committed
775
 **      of NAS encryption key Knas-enc from the Kasme.            **
Cedric Roux's avatar
 
Cedric Roux committed
776 777 778
 **                                                                        **
 **              3GPP TS 33.401, Annex A.7                                 **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
779 780 781
 ** Inputs:  kasme:     Key Access Security Management Entity      **
 **      eea:       Cyphering algorithm identity               **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
782
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
783 784 785
 ** Outputs:     knas_enc:  Derived key for NAS cyphering algorithm    **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
786 787
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
788 789
static int _security_knas_enc(const OctetString *kasme, OctetString *knas_enc,
                              UInt8_t eea)
Cedric Roux's avatar
 
Cedric Roux committed
790 791
{
    LOG_FUNC_IN;
792
    LOG_TRACE(INFO, "%s  with algo dist %d algo id %d", __FUNCTION__,0x01, eea);
Cedric Roux's avatar
 
Cedric Roux committed
793 794 795 796 797
    LOG_FUNC_RETURN (_security_kdf(kasme, knas_enc, 0x01, eea));
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
798
 ** Name:    _security_knas_int()                                      **
Cedric Roux's avatar
 
Cedric Roux committed
799 800
 **                                                                        **
 ** Description: Algorithm Key generation function used for the derivation **
Cedric Roux's avatar
Cedric Roux committed
801
 **      of NAS integrity key Knas-int from the Kasme.             **
Cedric Roux's avatar
 
Cedric Roux committed
802 803 804
 **                                                                        **
 **              3GPP TS 33.401, Annex A.7                                 **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
805 806 807
 ** Inputs:  kasme:     Key Access Security Management Entity      **
 **      eia:       Integrity algorithm identity               **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
808
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
809 810 811
 ** Outputs:     knas_int:  Derived key for NAS integrity algorithm    **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
812 813
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
814 815
static int _security_knas_int(const OctetString *kasme, OctetString *knas_int,
                              UInt8_t eia)
Cedric Roux's avatar
 
Cedric Roux committed
816 817
{
    LOG_FUNC_IN;
818
    LOG_TRACE(INFO, "%s  with algo dist %d algo id %d", __FUNCTION__,0x02, eia);
Cedric Roux's avatar
 
Cedric Roux committed
819 820 821 822 823
    LOG_FUNC_RETURN (_security_kdf(kasme, knas_int, 0x02, eia));
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
824
 ** Name:    _security_kenb()                                          **
Cedric Roux's avatar
 
Cedric Roux committed
825 826
 **                                                                        **
 ** Description: Computes the eNodeB key from Kasme and the given value of **
Cedric Roux's avatar
Cedric Roux committed
827
 **      uplink NAS counter.                                       **
Cedric Roux's avatar
 
Cedric Roux committed
828 829 830
 **                                                                        **
 **              3GPP TS 33.401, Annex A.3                                 **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
831 832 833
 ** Inputs:  kasme:     Key Access Security Management Entity      **
 **      count:     Uplink NAS counter value                   **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
834
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
835 836 837
 ** Outputs:     kenb:      eNodeB security key                        **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
838 839
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
840 841
static int _security_kenb(const OctetString *kasme, OctetString *kenb,
                          UInt32_t count)
Cedric Roux's avatar
 
Cedric Roux committed
842 843 844 845
{
    /* Compute the KDF input parameter
     * S = FC(0x11) || UL NAS Count || 0x00 0x04
     */
846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863
    UInt8_t  input[32];
    UInt16_t length    = 4;
    int      offset    = 0;

    LOG_TRACE(INFO, "%s  with count= %d", __FUNCTION__, count);
    memset(input, 0, 32);
    input[0] = 0x11;
    // P0
    input[1] = count >> 24;
    input[2] = (UInt8_t)(count >> 16);
    input[3] = (UInt8_t)(count >> 8);
    input[4] = (UInt8_t)count;
    // L0
    input[5] = 0;
    input[6] = 4;

    kdf(kasme->value, 32, input, 7, kenb->value, 32);
    kenb->length = 32;
Cedric Roux's avatar
 
Cedric Roux committed
864 865 866 867 868
    return (RETURNok);
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
869
 ** Name:    _security_kdf()                                           **
Cedric Roux's avatar
 
Cedric Roux committed
870 871
 **                                                                        **
 ** Description: Algorithm Key generation function used for the derivation **
Cedric Roux's avatar
Cedric Roux committed
872 873
 **      of keys for NAS integrity and NAS encryption algorithms   **
 **      from Kasme, algorithm types and algorithm identities.     **
Cedric Roux's avatar
 
Cedric Roux committed
874 875 876
 **                                                                        **
 **              3GPP TS 33.401, Annex A.7                                 **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
877 878 879 880
 ** Inputs:  kasme:     Key Access Security Management Entity      **
 **      algo_dist: Algorithm type distinguisher               **
 **      algo_id:   Algorithm identity                         **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
881
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
882 883 884
 ** Outputs:     key:       Derived key for NAS security protection    **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
885 886
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
887 888
static int _security_kdf(const OctetString *kasme, OctetString *key,
                         UInt8_t algo_dist, UInt8_t algo_id)
Cedric Roux's avatar
 
Cedric Roux committed
889 890 891
{
    /* Compute the KDF input parameter
     * S = FC(0x15) || Algorithm distinguisher || 0x00 0x01
Cedric Roux's avatar
Cedric Roux committed
892
            || Algorithm identity || 0x00 0x01
Cedric Roux's avatar
 
Cedric Roux committed
893
    */
894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916
    UInt8_t input[32];
    UInt8_t output[32];
    LOG_TRACE(DEBUG, "%s:%u output key mem %p lenth %u",
    		__FUNCTION__, __LINE__,
    		key->value,
    		key->length);
    memset(input, 0, 32);
    // FC
    input[0] = 0x15;
    // P0 = Algorithm distinguisher
    input[1] = algo_dist;
    // L0 = 0x00 01
    input[2] = 0x00;
    input[3] = 0x01;
    // P1 = Algorithm identity
    input[4] = algo_id;
    // L1 = length of Algorithm identity 0x00 0x01
    input[5] = 0x00;
    input[6] = 0x01;

    /* Compute the derived key */
    kdf(kasme->value, kasme->length, input, 7, output, 32);
    memcpy(key->value, &output[31 - key->length + 1], key->length);
Cedric Roux's avatar
 
Cedric Roux committed
917 918 919 920 921 922 923
    return (RETURNok);
}
#endif // NAS_UE

#ifdef NAS_MME
/*
 * --------------------------------------------------------------------------
Cedric Roux's avatar
Cedric Roux committed
924
 *              Timer handlers
Cedric Roux's avatar
 
Cedric Roux committed
925 926 927 928 929
 * --------------------------------------------------------------------------
 */

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
930
 ** Name:    _security_t3460_handler()                                 **
Cedric Roux's avatar
 
Cedric Roux committed
931 932
 **                                                                        **
 ** Description: T3460 timeout handler                                     **
Cedric Roux's avatar
Cedric Roux committed
933 934 935 936
 **      Upon T3460 timer expiration, the security mode command    **
 **      message is retransmitted and the timer restarted. When    **
 **      retransmission counter is exceed, the MME shall abort the **
 **      security mode control procedure.                          **
Cedric Roux's avatar
 
Cedric Roux committed
937 938 939
 **                                                                        **
 **              3GPP TS 24.301, section 5.4.3.7, case b                   **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
940 941
 ** Inputs:  args:      handler parameters                         **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
942
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
943 944 945
 ** Outputs:     None                                                      **
 **      Return:    None                                       **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
946 947
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
948
static void *_security_t3460_handler(void *args)
Cedric Roux's avatar
 
Cedric Roux committed
949 950 951 952 953
{
    LOG_FUNC_IN;

    int rc;

Cedric Roux's avatar
Cedric Roux committed
954
    security_data_t *data = (security_data_t *)(args);
Cedric Roux's avatar
 
Cedric Roux committed
955 956 957 958 959

    /* Increment the retransmission counter */
    data->retransmission_count += 1;

    LOG_TRACE(WARNING, "EMM-PROC  - T3460 timer expired, retransmission "
Cedric Roux's avatar
Cedric Roux committed
960
              "counter = %d", data->retransmission_count);
Cedric Roux's avatar
 
Cedric Roux committed
961 962

    if (data->retransmission_count < SECURITY_COUNTER_MAX) {
Cedric Roux's avatar
Cedric Roux committed
963 964 965 966 967 968 969
        /* Send security mode command message to the UE */
        rc = _security_request(data, FALSE);
    } else {
        /* Set the failure notification indicator */
        data->notify_failure = TRUE;
        /* Abort the security mode control procedure */
        rc = _security_abort(data);
Cedric Roux's avatar
 
Cedric Roux committed
970 971 972 973 974 975 976
    }

    LOG_FUNC_RETURN (NULL);
}

/*
 * --------------------------------------------------------------------------
Cedric Roux's avatar
Cedric Roux committed
977
 *              MME specific local functions
Cedric Roux's avatar
 
Cedric Roux committed
978 979 980 981 982
 * --------------------------------------------------------------------------
 */

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
983
 ** Name:    _security_request()                                       **
Cedric Roux's avatar
 
Cedric Roux committed
984 985 986
 **                                                                        **
 ** Description: Sends SECURITY MODE COMMAND message and start timer T3460 **
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
987 988 989 990
 ** Inputs:  data:      Security mode control internal data        **
 **      is_new:    Indicates whether a new security context   **
 **             has just been taken into use               **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
991
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
992 993 994
 ** Outputs:     None                                                      **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    T3460                                      **
Cedric Roux's avatar
 
Cedric Roux committed
995 996
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
997
int _security_request(security_data_t *data, int is_new)
Cedric Roux's avatar
 
Cedric Roux committed
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
{
    struct emm_data_context_s *emm_ctx = NULL;

    emm_sap_t emm_sap;
    int rc;

    LOG_FUNC_IN;

    /*
     * Notify EMM-AS SAP that Security Mode Command message has to be sent
     * to the UE
     */
    emm_sap.primitive = EMMAS_SECURITY_REQ;
1011 1012 1013 1014 1015 1016 1017 1018
    emm_sap.u.emm_as.u.security.guti         = NULL;
    emm_sap.u.emm_as.u.security.ueid         = data->ueid;
    emm_sap.u.emm_as.u.security.msgType      = EMM_AS_MSG_TYPE_SMC;
    emm_sap.u.emm_as.u.security.ksi          = data->ksi;
    emm_sap.u.emm_as.u.security.eea          = data->eea;
    emm_sap.u.emm_as.u.security.eia          = data->eia;
    emm_sap.u.emm_as.u.security.selected_eea = data->selected_eea;
    emm_sap.u.emm_as.u.security.selected_eia = data->selected_eia;
Cedric Roux's avatar
 
Cedric Roux committed
1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035

#if defined(EPC_BUILD)
    if (data->ueid > 0) {
        emm_ctx = emm_data_context_get(&_emm_data, data->ueid);
    }
#else
    if (data->ueid < EMM_DATA_NB_UE_MAX) {
        emm_ctx = _emm_data.ctx[data->ueid];
    }
#endif

    /* Setup EPS NAS security data */
    emm_as_set_security_data(&emm_sap.u.emm_as.u.security.sctx,
                             emm_ctx->security, is_new, FALSE);
    rc = emm_sap_send(&emm_sap);

    if (rc != RETURNerror) {
Cedric Roux's avatar
Cedric Roux committed
1036 1037 1038 1039 1040 1041 1042 1043 1044
        if (T3460.id != NAS_TIMER_INACTIVE_ID) {
            /* Re-start T3460 timer */
            T3460.id = nas_timer_restart(T3460.id);
        } else {
            /* Start T3460 timer */
            T3460.id = nas_timer_start(T3460.sec, _security_t3460_handler, data);
        }
        LOG_TRACE(INFO,"EMM-PROC  - Timer T3460 (%d) expires in %ld seconds",
                  T3460.id, T3460.sec);
Cedric Roux's avatar
 
Cedric Roux committed
1045 1046 1047 1048 1049 1050 1051
    }

    LOG_FUNC_RETURN (rc);
}

/****************************************************************************
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
1052
 ** Name:    _security_abort()                                         **
Cedric Roux's avatar
 
Cedric Roux committed
1053 1054
 **                                                                        **
 ** Description: Aborts the security mode control procedure currently in   **
Cedric Roux's avatar
Cedric Roux committed
1055
 **      progress                                                  **
Cedric Roux's avatar
 
Cedric Roux committed
1056
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
1057 1058
 ** Inputs:  args:      Security mode control data to be released  **
 **      Others:    None                                       **
Cedric Roux's avatar
 
Cedric Roux committed
1059
 **                                                                        **
Cedric Roux's avatar
Cedric Roux committed
1060 1061 1062
 ** Outputs:     None                                                      **
 **      Return:    RETURNok, RETURNerror                      **
 **      Others:    T3460                                      **
Cedric Roux's avatar
 
Cedric Roux committed
1063 1064
 **                                                                        **
 ***************************************************************************/
Cedric Roux's avatar
Cedric Roux committed
1065
static int _security_abort(void *args)
Cedric Roux's avatar
 
Cedric Roux committed
1066 1067 1068 1069 1070
{
    LOG_FUNC_IN;

    int rc = RETURNerror;

Cedric Roux's avatar
Cedric Roux committed
1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098
    security_data_t *data = (security_data_t *)(args);

    if (data) {
        unsigned int ueid = data->ueid;
        int notify_failure = data->notify_failure;

        LOG_TRACE(WARNING, "EMM-PROC  - Abort security mode control procedure "
                  "(ueid=%u)", ueid);

        /* Stop timer T3460 */
        if (T3460.id != NAS_TIMER_INACTIVE_ID) {
            LOG_TRACE(INFO, "EMM-PROC  - Stop timer T3460 (%d)", T3460.id);
            T3460.id = nas_timer_stop(T3460.id);
        }
        /* Release retransmission timer paramaters */
        free(data);

        /*
         * Notify EMM that the security mode control procedure failed
         */
        if (notify_failure) {
            emm_sap_t emm_sap;
            emm_sap.primitive = EMMREG_COMMON_PROC_REJ;
            emm_sap.u.emm_reg.ueid = ueid;
            rc = emm_sap_send(&emm_sap);
        } else {
            rc = RETURNok;
        }
Cedric Roux's avatar
 
Cedric Roux committed
1099 1100 1101 1102 1103
    }

    LOG_FUNC_RETURN (rc);
}

1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133

/****************************************************************************
 **                                                                        **
 ** Name:    _security_select_algorithms()                                 **
 **                                                                        **
 ** Description: Select int and enc algorithms based on UE capabilities and**
 **      MME capabilities and MME preferences                              **
 **                                                                        **
 ** Inputs:  ue_eia:      integrity algorithms supported by UE             **
 **          ue_eea:      ciphering algorithms supported by UE             **
 **                                                                        **
 ** Outputs: mme_eia:     integrity algorithms supported by MME            **
 **          mme_eea:     ciphering algorithms supported by MME            **
 **                                                                        **
 **      Return:    RETURNok, RETURNerror                                  **
 **      Others:    None                                                   **
 **                                                                        **
 ***************************************************************************/
static int _security_select_algorithms(
    const int   ue_eiaP,
    const int   ue_eeaP,
    int * const mme_eiaP,
    int * const mme_eeaP)
{
    LOG_FUNC_IN;

    int rc            = RETURNerror;

    /* TODO work with loaded preferences from config file */

Lionel Gauthier's avatar
 
Lionel Gauthier committed
1134
    if (ue_eiaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EIA1)) {
1135 1136
        LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EIA1");
        *mme_eiaP = NAS_SECURITY_ALGORITHMS_EIA1;
Lionel Gauthier's avatar
 
Lionel Gauthier committed
1137 1138 1139
    } else if (ue_eiaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EIA2)) {
        LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EIA2");
        *mme_eiaP = NAS_SECURITY_ALGORITHMS_EIA2;
1140 1141 1142 1143 1144 1145 1146
    } else if (ue_eiaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EIA0)) {
        LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EIA0");
        *mme_eiaP = NAS_SECURITY_ALGORITHMS_EIA0;
    } else {
        LOG_FUNC_RETURN (rc);
    }

Lionel Gauthier's avatar
Lionel Gauthier committed
1147 1148 1149 1150
    if (ue_eeaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EEA0)) {
            LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EEA0");
            *mme_eeaP = NAS_SECURITY_ALGORITHMS_EEA0;
    } else if (ue_eeaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EEA1)) {
1151 1152
            LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EEA1");
            *mme_eeaP = NAS_SECURITY_ALGORITHMS_EEA1;
1153 1154 1155 1156 1157 1158 1159 1160 1161 1162
    } else if (ue_eeaP & (0x80 >> NAS_SECURITY_ALGORITHMS_EEA2)) {
        LOG_TRACE(DEBUG,"Selected  NAS_SECURITY_ALGORITHMS_EEA2");
        *mme_eeaP = NAS_SECURITY_ALGORITHMS_EEA2;
    } else {
        LOG_FUNC_RETURN (rc);
    }

    LOG_FUNC_RETURN (RETURNok);
}

Cedric Roux's avatar
 
Cedric Roux committed
1163 1164
#endif // NAS_MME