<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/osmo-hlr/+/21880">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  laforge: Looks good to me, approved
  Jenkins Builder: Verified

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">support the XOR algorithm for UMTS AKA<br><br>Test USIMs as specified by 3GPP use the XOR algorithm not only for 2G<br>but also for 3G.  libosmocore includes the XOR-3G support since v1.3.0,<br>but osmo-hlr somehow never made use of it.<br><br>Change-Id: I3a452af9c18cd90d00ab4766d6bd1679456bc1a2<br>Closes: OS#4924<br>---<br>M src/db_hlr.c<br>M src/hlr_vty_subscr.c<br>M tests/auc/auc_test.c<br>M tests/auc/auc_test.err<br>M tests/test_subscriber.vty<br>5 files changed, 121 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/src/db_hlr.c b/src/db_hlr.c</span><br><span>index 83c2c51..6ba43c2 100644</span><br><span>--- a/src/db_hlr.c</span><br><span>+++ b/src/db_hlr.c</span><br><span>@@ -264,11 +264,11 @@</span><br><span>           switch (aud->algo) {</span><br><span>              case OSMO_AUTH_ALG_NONE:</span><br><span>             case OSMO_AUTH_ALG_MILENAGE:</span><br><span style="color: hsl(120, 100%, 40%);">+          case OSMO_AUTH_ALG_XOR:</span><br><span>                      break;</span><br><span>               case OSMO_AUTH_ALG_COMP128v1:</span><br><span>                case OSMO_AUTH_ALG_COMP128v2:</span><br><span>                case OSMO_AUTH_ALG_COMP128v3:</span><br><span style="color: hsl(0, 100%, 40%);">-           case OSMO_AUTH_ALG_XOR:</span><br><span>                      LOGP(DAUC, LOGL_ERROR, "Cannot update auth tokens:"</span><br><span>                             " auth algo not suited for 3G: %s\n",</span><br><span>                              osmo_auth_alg_name(aud->algo));</span><br><span>diff --git a/src/hlr_vty_subscr.c b/src/hlr_vty_subscr.c</span><br><span>index a9262ba..3dbc383 100644</span><br><span>--- a/src/hlr_vty_subscr.c</span><br><span>+++ b/src/hlr_vty_subscr.c</span><br><span>@@ -551,6 +551,55 @@</span><br><span>  return CMD_SUCCESS;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+DEFUN(subscriber_aud3g_xor,</span><br><span style="color: hsl(120, 100%, 40%);">+      subscriber_aud3g_xor_cmd,</span><br><span style="color: hsl(120, 100%, 40%);">+      SUBSCR_UPDATE "aud3g xor k K"</span><br><span style="color: hsl(120, 100%, 40%);">+      " [ind-bitlen] [<0-28>]",</span><br><span style="color: hsl(120, 100%, 40%);">+      SUBSCR_UPDATE_HELP</span><br><span style="color: hsl(120, 100%, 40%);">+      "Set UMTS authentication data (3G, and 2G with UMTS AKA)\n"</span><br><span style="color: hsl(120, 100%, 40%);">+      "Use XOR algorithm\n"</span><br><span style="color: hsl(120, 100%, 40%);">+      "Set Encryption Key K\n" "K as 32 hexadecimal characters\n"</span><br><span style="color: hsl(120, 100%, 40%);">+      "Set IND bit length\n" "IND bit length value (default: 5)\n")</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+   struct hlr_subscriber subscr;</span><br><span style="color: hsl(120, 100%, 40%);">+ int minlen = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+       int maxlen = 0;</span><br><span style="color: hsl(120, 100%, 40%);">+       int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+       const char *id_type = argv[0];</span><br><span style="color: hsl(120, 100%, 40%);">+        const char *id = argv[1];</span><br><span style="color: hsl(120, 100%, 40%);">+     const char *k = argv[2];</span><br><span style="color: hsl(120, 100%, 40%);">+      int ind_bitlen = argc > 4? atoi(argv[4]) : 5;</span><br><span style="color: hsl(120, 100%, 40%);">+      struct sub_auth_data_str aud3g = {</span><br><span style="color: hsl(120, 100%, 40%);">+            .type = OSMO_AUTH_TYPE_UMTS,</span><br><span style="color: hsl(120, 100%, 40%);">+          .u.umts = {</span><br><span style="color: hsl(120, 100%, 40%);">+                   .k = k,</span><br><span style="color: hsl(120, 100%, 40%);">+                       .opc_is_op = 0,</span><br><span style="color: hsl(120, 100%, 40%);">+                       .opc = "00000000000000000000000000000000",</span><br><span style="color: hsl(120, 100%, 40%);">+                  .ind_bitlen = ind_bitlen,</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%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+  if (!auth_algo_parse("xor", &aud3g.algo, &minlen, &maxlen)) {</span><br><span style="color: hsl(120, 100%, 40%);">+           vty_out(vty, "%% Unknown auth algorithm: '%s'%s", "xor", VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+            return CMD_WARNING;</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%);">+   if (!is_hexkey_valid(vty, "K", aud3g.u.umts.k, minlen, maxlen))</span><br><span style="color: hsl(120, 100%, 40%);">+             return CMD_WARNING;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (get_subscr_by_argv(vty, id_type, id, &subscr))</span><br><span style="color: hsl(120, 100%, 40%);">+                return CMD_WARNING;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = db_subscr_update_aud_by_id(g_hlr->dbc, subscr.id, &aud3g);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      if (rc) {</span><br><span style="color: hsl(120, 100%, 40%);">+             vty_out(vty, "%% Error: cannot set 3G auth data for IMSI='%s'%s",</span><br><span style="color: hsl(120, 100%, 40%);">+                   subscr.imsi, VTY_NEWLINE);</span><br><span style="color: hsl(120, 100%, 40%);">+            return CMD_WARNING;</span><br><span style="color: hsl(120, 100%, 40%);">+   }</span><br><span style="color: hsl(120, 100%, 40%);">+     return CMD_SUCCESS;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> DEFUN(subscriber_imei,</span><br><span>       subscriber_imei_cmd,</span><br><span>       SUBSCR_UPDATE "imei (none|IMEI)",</span><br><span>@@ -637,6 +686,7 @@</span><br><span>  install_element(ENABLE_NODE, &subscriber_aud2g_cmd);</span><br><span>     install_element(ENABLE_NODE, &subscriber_no_aud3g_cmd);</span><br><span>  install_element(ENABLE_NODE, &subscriber_aud3g_cmd);</span><br><span style="color: hsl(120, 100%, 40%);">+      install_element(ENABLE_NODE, &subscriber_aud3g_xor_cmd);</span><br><span>         install_element(ENABLE_NODE, &subscriber_imei_cmd);</span><br><span>      install_element(ENABLE_NODE, &subscriber_nam_cmd);</span><br><span> }</span><br><span>diff --git a/tests/auc/auc_test.c b/tests/auc/auc_test.c</span><br><span>index cdbd0b7..db7edcb 100644</span><br><span>--- a/tests/auc/auc_test.c</span><br><span>+++ b/tests/auc/auc_test.c</span><br><span>@@ -454,6 +454,50 @@</span><br><span>      comment_end();</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static void test_gen_vectors_3g_xor(void)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct osmo_sub_auth_data aud2g;</span><br><span style="color: hsl(120, 100%, 40%);">+      struct osmo_sub_auth_data aud3g;</span><br><span style="color: hsl(120, 100%, 40%);">+      struct osmo_auth_vector vec;</span><br><span style="color: hsl(120, 100%, 40%);">+  int rc;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+     comment_start();</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+    aud2g = (struct osmo_sub_auth_data){ 0 };</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+   aud3g = (struct osmo_sub_auth_data){</span><br><span style="color: hsl(120, 100%, 40%);">+          .type = OSMO_AUTH_TYPE_UMTS,</span><br><span style="color: hsl(120, 100%, 40%);">+          .algo = OSMO_AUTH_ALG_XOR,</span><br><span style="color: hsl(120, 100%, 40%);">+            .u.umts.sqn = 0,</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%);">+  osmo_hexparse("000102030405060708090a0b0c0d0e0f",</span><br><span style="color: hsl(120, 100%, 40%);">+                 aud3g.u.umts.k, sizeof(aud3g.u.umts.k));</span><br><span style="color: hsl(120, 100%, 40%);">+        osmo_hexparse("00000000000000000000000000000000",</span><br><span style="color: hsl(120, 100%, 40%);">+                 aud3g.u.umts.opc, sizeof(aud3g.u.umts.opc));</span><br><span style="color: hsl(120, 100%, 40%);">+    next_rand("b5039c57e4a75051551d1a390a71ce48", true);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+      vec = (struct osmo_auth_vector){ {0} };</span><br><span style="color: hsl(120, 100%, 40%);">+       VERBOSE_ASSERT(aud3g.u.umts.sqn, == 0, "%"PRIu64);</span><br><span style="color: hsl(120, 100%, 40%);">+  rc = auc_compute_vectors(&vec, 1, &aud2g, &aud3g, NULL, NULL);</span><br><span style="color: hsl(120, 100%, 40%);">+    VERBOSE_ASSERT(rc, == 1, "%d");</span><br><span style="color: hsl(120, 100%, 40%);">+     VERBOSE_ASSERT(aud3g.u.umts.sqn, == 0, "%"PRIu64);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+        VEC_IS(&vec,</span><br><span style="color: hsl(120, 100%, 40%);">+             "  rand: b5039c57e4a75051551d1a390a71ce48\n"</span><br><span style="color: hsl(120, 100%, 40%);">+        "  autn: 54e0a256565d0000b5029e54e0a25656\n"</span><br><span style="color: hsl(120, 100%, 40%);">+        "  ck: 029e54e0a256565d141032067cc047b5\n"</span><br><span style="color: hsl(120, 100%, 40%);">+          "  ik: 9e54e0a256565d141032067cc047b502\n"</span><br><span style="color: hsl(120, 100%, 40%);">+          "  res: b5029e54e0a256565d141032067cc047\n"</span><br><span style="color: hsl(120, 100%, 40%);">+         "  res_len: 10\n"</span><br><span style="color: hsl(120, 100%, 40%);">+           "  kc: 98e880384887f9fe\n"</span><br><span style="color: hsl(120, 100%, 40%);">+          "  sres: 0ec81877\n"</span><br><span style="color: hsl(120, 100%, 40%);">+        "  auth_types: 03000000\n"</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%);">+    comment_end();</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> void test_gen_vectors_bad_args()</span><br><span> {</span><br><span>         struct osmo_auth_vector vec;</span><br><span>@@ -622,6 +666,7 @@</span><br><span>   test_gen_vectors_2g_only();</span><br><span>  test_gen_vectors_2g_plus_3g();</span><br><span>       test_gen_vectors_3g_only();</span><br><span style="color: hsl(120, 100%, 40%);">+   test_gen_vectors_3g_xor();</span><br><span>   test_gen_vectors_bad_args();</span><br><span> </span><br><span>     printf("Done\n");</span><br><span>diff --git a/tests/auc/auc_test.err b/tests/auc/auc_test.err</span><br><span>index 0a4d9af..f83e814 100644</span><br><span>--- a/tests/auc/auc_test.err</span><br><span>+++ b/tests/auc/auc_test.err</span><br><span>@@ -217,6 +217,29 @@</span><br><span> ===== test_gen_vectors_3g_only: SUCCESS</span><br><span> </span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+===== test_gen_vectors_3g_xor</span><br><span style="color: hsl(120, 100%, 40%);">+aud3g.u.umts.sqn == 0</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC Computing 1 auth vector: 3G only (2G derived from 3G keys)</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC 3G: k = 000102030405060708090a0b0c0d0e0f</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC 3G: opc = 00000000000000000000000000000000</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC 3G: for sqn ind 0, previous sqn was 0</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: rand = b5039c57e4a75051551d1a390a71ce48</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: sqn = 0</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: autn = 54e0a256565d0000b5029e54e0a25656</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: ck = 029e54e0a256565d141032067cc047b5</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: ik = 9e54e0a256565d141032067cc047b502</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: res = b5029e54e0a256565d141032067cc047</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: res_len = 16</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: deriving 2G from 3G</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: kc = 98e880384887f9fe</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: sres = 0ec81877</span><br><span style="color: hsl(120, 100%, 40%);">+DAUC vector [0]: auth_types = 0x3</span><br><span style="color: hsl(120, 100%, 40%);">+rc == 1</span><br><span style="color: hsl(120, 100%, 40%);">+aud3g.u.umts.sqn == 0</span><br><span style="color: hsl(120, 100%, 40%);">+vector matches expectations</span><br><span style="color: hsl(120, 100%, 40%);">+===== test_gen_vectors_3g_xor: SUCCESS</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> ===== test_gen_vectors_bad_args</span><br><span> </span><br><span> - no auth data (a)</span><br><span>diff --git a/tests/test_subscriber.vty b/tests/test_subscriber.vty</span><br><span>index 4082700..fe7499c 100644</span><br><span>--- a/tests/test_subscriber.vty</span><br><span>+++ b/tests/test_subscriber.vty</span><br><span>@@ -11,6 +11,7 @@</span><br><span>   subscriber (imsi|msisdn|id|imei) IDENT update aud2g (comp128v1|comp128v2|comp128v3|xor) ki KI</span><br><span>   subscriber (imsi|msisdn|id|imei) IDENT update aud3g none</span><br><span>   subscriber (imsi|msisdn|id|imei) IDENT update aud3g milenage k K (op|opc) OP_C [ind-bitlen] [<0-28>]</span><br><span style="color: hsl(120, 100%, 40%);">+  subscriber (imsi|msisdn|id|imei) IDENT update aud3g xor k K [ind-bitlen] [<0-28>]</span><br><span>   subscriber (imsi|msisdn|id|imei) IDENT update imei (none|IMEI)</span><br><span>   subscriber (imsi|msisdn|id|imei) IDENT update network-access-mode (none|cs|ps|cs+ps)</span><br><span>   show mslookup services</span><br><span>@@ -268,6 +269,7 @@</span><br><span> OsmoHLR# subscriber imsi 123456789023000 update aud3g ?</span><br><span>   none      Delete 3G authentication data</span><br><span>   milenage  Use Milenage algorithm</span><br><span style="color: hsl(120, 100%, 40%);">+  xor       Use XOR algorithm</span><br><span> </span><br><span> OsmoHLR# subscriber imsi 123456789023000 update aud3g milenage ?</span><br><span>   k  Set Encryption Key K</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-hlr/+/21880">change 21880</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/c/osmo-hlr/+/21880"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-hlr </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: I3a452af9c18cd90d00ab4766d6bd1679456bc1a2 </div>
<div style="display:none"> Gerrit-Change-Number: 21880 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: fixeria <vyanitskiy@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: neels <nhofmeyr@sysmocom.de> </div>
<div style="display:none"> Gerrit-Reviewer: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>