<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/12409">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  Jenkins Builder: Verified
  Harald Welte: Looks good to me, approved

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">GSUP: add CHECK-IMEI message<br><br>Implement necessary messages for Procedure Check_IMEI_VLR (TS 23.018<br>Chapter 7.1.2.9). This lets the VLR ask the EIR to check if an IMEI<br>is valid. In the Osmocom stack, we don't have an EIR and this request<br>will be handled by the HLR. We will be able to store the IMEI in the<br>HLR as side-effect (OS#2541).<br><br>This is roughly based on TS 29.002 8.7.1 MAP_CHECK_IMEI service, but<br>only implements the bare minimum required IEs (imei and imei_result).<br><br>Related: OS#3733<br>Change-Id: I085819df0ea7f3bfeb0cabebb5fd1942a23c6155<br>---<br>M include/osmocom/gsm/gsup.h<br>M src/gsm/gsup.c<br>M tests/gsup/gsup_test.c<br>M tests/gsup/gsup_test.err<br>M tests/gsup/gsup_test.ok<br>5 files changed, 93 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/gsup.h b/include/osmocom/gsm/gsup.h</span><br><span>index 37e474c..6adb0bf 100644</span><br><span>--- a/include/osmocom/gsm/gsup.h</span><br><span>+++ b/include/osmocom/gsm/gsup.h</span><br><span>@@ -99,6 +99,9 @@</span><br><span>        OSMO_GSUP_SM_RP_MMS_IE                  = 0x45,</span><br><span>      OSMO_GSUP_SM_ALERT_RSN_IE               = 0x46,</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+   OSMO_GSUP_IMEI_IE                       = 0x50,</span><br><span style="color: hsl(120, 100%, 40%);">+       OSMO_GSUP_IMEI_RESULT_IE                = 0x51,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>    _OSMO_GSUP_IEI_END_MARKER</span><br><span> };</span><br><span> </span><br><span>@@ -145,6 +148,10 @@</span><br><span>   OSMO_GSUP_MSGT_READY_FOR_SM_REQUEST     = 0b00101100,</span><br><span>        OSMO_GSUP_MSGT_READY_FOR_SM_ERROR       = 0b00101101,</span><br><span>        OSMO_GSUP_MSGT_READY_FOR_SM_RESULT      = 0b00101110,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+       OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST       = 0b00110000,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_GSUP_MSGT_CHECK_IMEI_ERROR         = 0b00110001,</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_GSUP_MSGT_CHECK_IMEI_RESULT        = 0b00110010,</span><br><span> };</span><br><span> </span><br><span> #define OSMO_GSUP_IS_MSGT_REQUEST(msgt) (((msgt) & 0b00000011) == 0b00)</span><br><span>@@ -166,6 +173,11 @@</span><br><span>        OSMO_GSUP_CN_DOMAIN_CS                  = 2,</span><br><span> };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+enum osmo_gsup_imei_result {</span><br><span style="color: hsl(120, 100%, 40%);">+  OSMO_GSUP_IMEI_RESULT_ACK               = 1,</span><br><span style="color: hsl(120, 100%, 40%);">+  OSMO_GSUP_IMEI_RESULT_NACK              = 2,</span><br><span style="color: hsl(120, 100%, 40%);">+};</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! TCAP-like session state */</span><br><span> enum osmo_gsup_session_state {</span><br><span>       /*! Undefined session state */</span><br><span>@@ -259,6 +271,10 @@</span><br><span>        const uint8_t                   *sm_rp_mms;</span><br><span>  /*! Alert reason (see 3GPP TS 29.002, 7.6.8.8) */</span><br><span>    enum osmo_gsup_sms_sm_alert_rsn_t       sm_alert_rsn;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+       const uint8_t                   *imei_enc;</span><br><span style="color: hsl(120, 100%, 40%);">+    size_t                          imei_enc_len;</span><br><span style="color: hsl(120, 100%, 40%);">+ enum osmo_gsup_imei_result      imei_result;</span><br><span> };</span><br><span> </span><br><span> int osmo_gsup_decode(const uint8_t *data, size_t data_len,</span><br><span>diff --git a/src/gsm/gsup.c b/src/gsm/gsup.c</span><br><span>index 3b31d03..3d2a8e2 100644</span><br><span>--- a/src/gsm/gsup.c</span><br><span>+++ b/src/gsm/gsup.c</span><br><span>@@ -79,6 +79,10 @@</span><br><span>       OSMO_VALUE_STRING(OSMO_GSUP_MSGT_READY_FOR_SM_ERROR),</span><br><span>        OSMO_VALUE_STRING(OSMO_GSUP_MSGT_READY_FOR_SM_RESULT),</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+    OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST),</span><br><span style="color: hsl(120, 100%, 40%);">+ OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_ERROR),</span><br><span style="color: hsl(120, 100%, 40%);">+   OSMO_VALUE_STRING(OSMO_GSUP_MSGT_CHECK_IMEI_RESULT),</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>       { 0, NULL }</span><br><span> };</span><br><span> </span><br><span>@@ -116,6 +120,8 @@</span><br><span>          return OSMO_GSUP_MSGT_MT_FORWARD_SM_ERROR;</span><br><span>   case OSMO_GSUP_MSGT_READY_FOR_SM_REQUEST:</span><br><span>            return OSMO_GSUP_MSGT_READY_FOR_SM_ERROR;</span><br><span style="color: hsl(120, 100%, 40%);">+     case OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST:</span><br><span style="color: hsl(120, 100%, 40%);">+               return OSMO_GSUP_MSGT_CHECK_IMEI_ERROR;</span><br><span>      default:</span><br><span>             return -1;</span><br><span>   }</span><br><span>@@ -487,6 +493,15 @@</span><br><span>                     gsup_msg->sm_alert_rsn = *value;</span><br><span>                  break;</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+            case OSMO_GSUP_IMEI_IE:</span><br><span style="color: hsl(120, 100%, 40%);">+                       gsup_msg->imei_enc = value;</span><br><span style="color: hsl(120, 100%, 40%);">+                        gsup_msg->imei_enc_len = value_len;</span><br><span style="color: hsl(120, 100%, 40%);">+                        break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+              case OSMO_GSUP_IMEI_RESULT_IE:</span><br><span style="color: hsl(120, 100%, 40%);">+                        gsup_msg->imei_result = osmo_decode_big_endian(value, value_len) + 1;</span><br><span style="color: hsl(120, 100%, 40%);">+                      break;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>             default:</span><br><span>                     LOGP(DLGSUP, LOGL_NOTICE,</span><br><span>                         "GSUP IE type %d unknown\n", iei);</span><br><span>@@ -720,6 +735,14 @@</span><br><span>                             sizeof(u8), &u8);</span><br><span>        }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+ if (gsup_msg->imei_enc)</span><br><span style="color: hsl(120, 100%, 40%);">+            msgb_tlv_put(msg, OSMO_GSUP_IMEI_IE, gsup_msg->imei_enc_len, gsup_msg->imei_enc);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     if ((u8 = gsup_msg->imei_result)) {</span><br><span style="color: hsl(120, 100%, 40%);">+                u8 -= 1;</span><br><span style="color: hsl(120, 100%, 40%);">+              msgb_tlv_put(msg, OSMO_GSUP_IMEI_RESULT_IE, sizeof(u8), &u8);</span><br><span style="color: hsl(120, 100%, 40%);">+     }</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>  return 0;</span><br><span> }</span><br><span> </span><br><span>diff --git a/tests/gsup/gsup_test.c b/tests/gsup/gsup_test.c</span><br><span>index 079a703..f194573 100644</span><br><span>--- a/tests/gsup/gsup_test.c</span><br><span>+++ b/tests/gsup/gsup_test.c</span><br><span>@@ -289,6 +289,33 @@</span><br><span>                       0x02, /* Memory Available (SMMA) */</span><br><span>  };</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+        static const uint8_t send_check_imei_req[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+                0x30, /* OSMO_GSUP_MSGT_CHECK_IMEI_REQUEST */</span><br><span style="color: hsl(120, 100%, 40%);">+         TEST_IMSI_IE,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+               /* imei */</span><br><span style="color: hsl(120, 100%, 40%);">+            0x50, 0x09,</span><br><span style="color: hsl(120, 100%, 40%);">+                   0x42, 0x42, 0x42, 0x42, 0x42, 0x42, 0x42, 0x42, 0x42,</span><br><span style="color: hsl(120, 100%, 40%);">+ };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  static const uint8_t send_check_imei_err[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+                0x31, /* OSMO_GSUP_MSGT_CHECK_IMEI_ERROR */</span><br><span style="color: hsl(120, 100%, 40%);">+           TEST_IMSI_IE,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+               /* cause */</span><br><span style="color: hsl(120, 100%, 40%);">+           0x02, 0x01,</span><br><span style="color: hsl(120, 100%, 40%);">+                   0x60, /* GMM_CAUSE_INV_MAND_INFO */</span><br><span style="color: hsl(120, 100%, 40%);">+   };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  static const uint8_t send_check_imei_res[] = {</span><br><span style="color: hsl(120, 100%, 40%);">+                0x32, /* OSMO_GSUP_MSGT_CHECK_IMEI_RESULT */</span><br><span style="color: hsl(120, 100%, 40%);">+          TEST_IMSI_IE,</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+               /* imei_result */</span><br><span style="color: hsl(120, 100%, 40%);">+             0x51, 0x01,</span><br><span style="color: hsl(120, 100%, 40%);">+                   0x00, /* OSMO_GSUP_IMEI_RESULT_ACK */</span><br><span style="color: hsl(120, 100%, 40%);">+ };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span>         static const struct test {</span><br><span>           char *name;</span><br><span>          const uint8_t *data;</span><br><span>@@ -338,6 +365,12 @@</span><br><span>                  send_mo_mt_forward_sm_err, sizeof(send_mo_mt_forward_sm_err)},</span><br><span>               {"ReadyForSM (MSC -> SMSC) Indication",</span><br><span>                         send_ready_for_sm_ind, sizeof(send_ready_for_sm_ind)},</span><br><span style="color: hsl(120, 100%, 40%);">+                {"Check IMEI Request",</span><br><span style="color: hsl(120, 100%, 40%);">+                      send_check_imei_req, sizeof(send_check_imei_req)},</span><br><span style="color: hsl(120, 100%, 40%);">+            {"Check IMEI Error",</span><br><span style="color: hsl(120, 100%, 40%);">+                        send_check_imei_err, sizeof(send_check_imei_err)},</span><br><span style="color: hsl(120, 100%, 40%);">+            {"Check IMEI Result",</span><br><span style="color: hsl(120, 100%, 40%);">+                       send_check_imei_res, sizeof(send_check_imei_res)},</span><br><span>   };</span><br><span> </span><br><span>       printf("Test GSUP message decoding/encoding\n");</span><br><span>diff --git a/tests/gsup/gsup_test.err b/tests/gsup/gsup_test.err</span><br><span>index 236c38a..73b35fc 100644</span><br><span>--- a/tests/gsup/gsup_test.err</span><br><span>+++ b/tests/gsup/gsup_test.err</span><br><span>@@ -64,6 +64,15 @@</span><br><span>   generated message: 2c 01 08 21 43 65 87 09 21 43 f5 46 01 02 </span><br><span>   original message:  2c 01 08 21 43 65 87 09 21 43 f5 46 01 02 </span><br><span>   IMSI:              123456789012345</span><br><span style="color: hsl(120, 100%, 40%);">+  generated message: 30 01 08 21 43 65 87 09 21 43 f5 50 09 42 42 42 42 42 42 42 42 42 </span><br><span style="color: hsl(120, 100%, 40%);">+  original message:  30 01 08 21 43 65 87 09 21 43 f5 50 09 42 42 42 42 42 42 42 42 42 </span><br><span style="color: hsl(120, 100%, 40%);">+  IMSI:              123456789012345</span><br><span style="color: hsl(120, 100%, 40%);">+  generated message: 31 01 08 21 43 65 87 09 21 43 f5 02 01 60 </span><br><span style="color: hsl(120, 100%, 40%);">+  original message:  31 01 08 21 43 65 87 09 21 43 f5 02 01 60 </span><br><span style="color: hsl(120, 100%, 40%);">+  IMSI:              123456789012345</span><br><span style="color: hsl(120, 100%, 40%);">+  generated message: 32 01 08 21 43 65 87 09 21 43 f5 51 01 00 </span><br><span style="color: hsl(120, 100%, 40%);">+  original message:  32 01 08 21 43 65 87 09 21 43 f5 51 01 00 </span><br><span style="color: hsl(120, 100%, 40%);">+  IMSI:              123456789012345</span><br><span>   message 0: tested 11 truncations, 11 parse failures</span><br><span>   message 1: tested 14 truncations, 13 parse failures</span><br><span>   message 2: tested 83 truncations, 81 parse failures</span><br><span>@@ -86,6 +95,9 @@</span><br><span>   message 19: tested 20 truncations, 18 parse failures</span><br><span>   message 20: tested 26 truncations, 22 parse failures</span><br><span>   message 21: tested 14 truncations, 13 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 22: tested 22 truncations, 21 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 23: tested 14 truncations, 13 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 24: tested 14 truncations, 13 parse failures</span><br><span> DLGSUP Stopping DLGSUP logging</span><br><span>   message 0: tested 2816 modifications, 510 parse failures</span><br><span>   message 1: tested 3584 modifications, 770 parse failures</span><br><span>@@ -109,3 +121,6 @@</span><br><span>   message 19: tested 5120 modifications, 1031 parse failures</span><br><span>   message 20: tested 6656 modifications, 1546 parse failures</span><br><span>   message 21: tested 3584 modifications, 771 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 22: tested 5632 modifications, 771 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 23: tested 3584 modifications, 770 parse failures</span><br><span style="color: hsl(120, 100%, 40%);">+  message 24: tested 3584 modifications, 771 parse failures</span><br><span>diff --git a/tests/gsup/gsup_test.ok b/tests/gsup/gsup_test.ok</span><br><span>index 36e35c8..70f723c 100644</span><br><span>--- a/tests/gsup/gsup_test.ok</span><br><span>+++ b/tests/gsup/gsup_test.ok</span><br><span>@@ -43,4 +43,10 @@</span><br><span>           MO-/MT-ForwardSM Error OK</span><br><span>   Testing ReadyForSM (MSC -> SMSC) Indication</span><br><span>           ReadyForSM (MSC -> SMSC) Indication OK</span><br><span style="color: hsl(120, 100%, 40%);">+  Testing Check IMEI Request</span><br><span style="color: hsl(120, 100%, 40%);">+          Check IMEI Request OK</span><br><span style="color: hsl(120, 100%, 40%);">+  Testing Check IMEI Error</span><br><span style="color: hsl(120, 100%, 40%);">+          Check IMEI Error OK</span><br><span style="color: hsl(120, 100%, 40%);">+  Testing Check IMEI Result</span><br><span style="color: hsl(120, 100%, 40%);">+          Check IMEI Result OK</span><br><span> Done.</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/12409">change 12409</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/12409"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: libosmocore </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-MessageType: merged </div>
<div style="display:none"> Gerrit-Change-Id: I085819df0ea7f3bfeb0cabebb5fd1942a23c6155 </div>
<div style="display:none"> Gerrit-Change-Number: 12409 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: osmith <osmith@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Harald Welte <laforge@gnumonks.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder (1000002) </div>
<div style="display:none"> Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: Vadim Yanitskiy <axilirator@gmail.com> </div>
<div style="display:none"> Gerrit-Reviewer: osmith <osmith@sysmocom.de> </div>