srsRAN_4G/srsue/hdr/stack/upper/usim.h

/*
 * Copyright 2013-2020 Software Radio Systems Limited
 *
 * This file is part of srsLTE.
 *
 * srsLTE is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version.
 *
 * srsLTE 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 Affero General Public License for more details.
 *
 * A copy of the GNU Affero General Public License can be found in
 * the LICENSE file in the top-level directory of this distribution
 * and at http://www.gnu.org/licenses/.
 *
 */

#ifndef SRSUE_USIM_H
#define SRSUE_USIM_H

#include "srslte/common/common.h"
#include "srslte/common/log.h"
#include "srslte/common/security.h"
#include "srslte/interfaces/ue_interfaces.h"
#include "usim_base.h"
#include <string>

namespace srsue {

class usim : public usim_base
{
public:
  usim(srslte::log* log_);
  int  init(usim_args_t* args);
  void stop();

  // NAS interface
  std::string get_imsi_str();
  std::string get_imei_str();

  bool get_imsi_vec(uint8_t* imsi_, uint32_t n);
  bool get_imei_vec(uint8_t* imei_, uint32_t n);
  bool get_home_plmn_id(srslte::plmn_id_t* home_plmn_id);

  auth_result_t generate_authentication_response(uint8_t* rand,
                                                 uint8_t* autn_enb,
                                                 uint16_t mcc,
                                                 uint16_t mnc,
                                                 uint8_t* res,
                                                 int*     res_len,
                                                 uint8_t* k_asme);

  void generate_nas_keys(uint8_t*                            k_asme,
                         uint8_t*                            k_nas_enc,
                         uint8_t*                            k_nas_int,
                         srslte::CIPHERING_ALGORITHM_ID_ENUM cipher_algo,
                         srslte::INTEGRITY_ALGORITHM_ID_ENUM integ_algo);

  // RRC interface
  void generate_as_keys(uint8_t* k_asme, uint32_t count_ul, srslte::as_security_config_t* sec_cfg);
  void generate_as_keys_ho(uint32_t pci, uint32_t earfcn, int ncc, srslte::as_security_config_t* sec_cfg);
  void store_keys_before_ho(const srslte::as_security_config_t& as_ctx);
  void restore_keys_from_failed_ho(srslte::as_security_config_t* as_ctx);

private:
  auth_result_t gen_auth_res_milenage(uint8_t* rand,
                                      uint8_t* autn_enb,
                                      uint16_t mcc,
                                      uint16_t mnc,
                                      uint8_t* res,
                                      int*     res_len,
                                      uint8_t* k_asme);
  auth_result_t gen_auth_res_xor(uint8_t* rand,
                                 uint8_t* autn_enb,
                                 uint16_t mcc,
                                 uint16_t mnc,
                                 uint8_t* res,
                                 int*     res_len,
                                 uint8_t* k_asme);
  void          str_to_hex(std::string str, uint8_t* hex);

  srslte::log* usim_log = nullptr;

  // User data
  auth_algo_t auth_algo = auth_algo_milenage;
  uint8_t     amf[2]    = {}; // 3GPP 33.102 v10.0.0 Annex H
  uint8_t     op[16]    = {};
  uint8_t     opc[16]   = {};
  uint64_t    imsi      = 0;
  uint64_t    imei      = 0;
  uint8_t     k[16]     = {};

  std::string imsi_str;
  std::string imei_str;

  // Security variables
  uint8_t ck[16]            = {};
  uint8_t ik[16]            = {};
  uint8_t ak[6]             = {};
  uint8_t mac[8]            = {};
  uint8_t autn[16]          = {};
  uint8_t k_asme[32]        = {};
  uint8_t nh[32]            = {};
  uint8_t k_enb_initial[32] = {};
  uint8_t k_enb[32]         = {};
  uint8_t k_enb_star[32]    = {};

  // Helpers to restore security context if HO fails
  uint8_t                      old_k_enb[32] = {};
  uint8_t                      old_ncc       = {};
  srslte::as_security_config_t old_as_ctx    = {};

  uint32_t current_ncc  = 0;
  bool     is_first_ncc = false;

  bool initiated = false;
};

} // namespace srsue

#endif // SRSUE_USIM_H