<p>Harald Welte <strong>merged</strong> this change.</p><p><a href="https://gerrit.osmocom.org/11601">View Change</a></p><div style="white-space:pre-wrap">Approvals:
Harald Welte: Looks good to me, approved
Jenkins Builder: Verified
</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">Support cipher mode reject with extended cause<br><br>* add function to generate cipher mode reject with extended (2-byte)<br> Cause IE<br>* add function to get (extended) Cause value<br>* add corresponding (extended cause) test<br>* update existing (non-extended cause) test<br>* use enum as a parameter for existing non-extended version to make<br> interface more unified<br><br>Change-Id: Id5509b94a18180a44f45300caaa02b843c166fa3<br>Related: OS#3187<br>---<br>M include/osmocom/gsm/gsm0808.h<br>M include/osmocom/gsm/gsm0808_utils.h<br>M src/gsm/gsm0808.c<br>M src/gsm/gsm0808_utils.c<br>M src/gsm/libosmogsm.map<br>M tests/gsm0808/gsm0808_test.c<br>M tests/gsm0808/gsm0808_test.ok<br>7 files changed, 89 insertions(+), 1 deletion(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/gsm0808.h b/include/osmocom/gsm/gsm0808.h</span><br><span>index 66f7c27..9b19d69 100644</span><br><span>--- a/include/osmocom/gsm/gsm0808.h</span><br><span>+++ b/include/osmocom/gsm/gsm0808.h</span><br><span>@@ -51,6 +51,7 @@</span><br><span> const uint8_t *cipher_response_mode);</span><br><span> struct msgb *gsm0808_create_cipher_complete(struct msgb *layer3, uint8_t alg_id);</span><br><span> struct msgb *gsm0808_create_cipher_reject(enum gsm0808_cause cause);</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext);</span><br><span> struct msgb *gsm0808_create_classmark_request();</span><br><span> struct msgb *gsm0808_create_classmark_update(const uint8_t *cm2, uint8_t cm2_len,</span><br><span> const uint8_t *cm3, uint8_t cm3_len);</span><br><span>diff --git a/include/osmocom/gsm/gsm0808_utils.h b/include/osmocom/gsm/gsm0808_utils.h</span><br><span>index b56e263..c22d0a9 100644</span><br><span>--- a/include/osmocom/gsm/gsm0808_utils.h</span><br><span>+++ b/include/osmocom/gsm/gsm0808_utils.h</span><br><span>@@ -120,6 +120,8 @@</span><br><span> return (cause & 0x80) && !(cause & 0x0F);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+int gsm0808_get_cipher_reject_cause(const struct tlv_parsed *tp);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! \returns 3GPP TS 48.008 3.2.2.49 Current Channel Type 1 from enum gsm_chan_t. */</span><br><span> static inline uint8_t gsm0808_current_channel_type_1(enum gsm_chan_t type)</span><br><span> {</span><br><span>diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c</span><br><span>index c413688..a84e717 100644</span><br><span>--- a/src/gsm/gsm0808.c</span><br><span>+++ b/src/gsm/gsm0808.c</span><br><span>@@ -283,6 +283,30 @@</span><br><span> return msg;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Create BSSMAP Cipher Mode Reject message</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] class 3GPP TS 08.08 §3.2.2.5 cause's class</span><br><span style="color: hsl(120, 100%, 40%);">+ * \param[in] ext 3GPP TS 08.08 §3.2.2.5 cause value (national application extension)</span><br><span style="color: hsl(120, 100%, 40%);">+ * \returns callee-allocated msgb with BSSMAP Cipher Mode Reject message */</span><br><span style="color: hsl(120, 100%, 40%);">+struct msgb *gsm0808_create_cipher_reject_ext(enum gsm0808_cause_class class, uint8_t ext)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t c[2];</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg = msgb_alloc_headroom(BSSMAP_MSG_SIZE, BSSMAP_MSG_HEADROOM,</span><br><span style="color: hsl(120, 100%, 40%);">+ "bssmap: cipher mode reject");</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!msg)</span><br><span style="color: hsl(120, 100%, 40%);">+ return NULL;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ c[0] = 0x80 | (class << 4); /* set the high bit to indicate extended cause */</span><br><span style="color: hsl(120, 100%, 40%);">+ c[1] = ext;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_v_put(msg, BSS_MAP_MSG_CIPHER_MODE_REJECT);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_tlv_put(msg, GSM0808_IE_CAUSE, 2, c);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l3h = msgb_tv_push(msg, BSSAP_MSG_BSS_MANAGEMENT, msgb_length(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ return msg;</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Create BSSMAP LCLS CONNECT CONTROL message (TS 48.008 3.2.1.91).</span><br><span> * \param[in] config LCLS Configuration</span><br><span> * \param[in] control LCLS Connection Status Control</span><br><span>diff --git a/src/gsm/gsm0808_utils.c b/src/gsm/gsm0808_utils.c</span><br><span>index 2348105..c58d828 100644</span><br><span>--- a/src/gsm/gsm0808_utils.c</span><br><span>+++ b/src/gsm/gsm0808_utils.c</span><br><span>@@ -1235,6 +1235,22 @@</span><br><span> cfg->icmi = 1;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+int gsm0808_get_cipher_reject_cause(const struct tlv_parsed *tp)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ const uint8_t *buf = TLVP_VAL_MINLEN(tp, GSM0808_IE_CAUSE, 1);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!buf)</span><br><span style="color: hsl(120, 100%, 40%);">+ return -EBADMSG;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (TLVP_LEN(tp, GSM0808_IE_CAUSE) > 1) {</span><br><span style="color: hsl(120, 100%, 40%);">+ if (!gsm0808_cause_ext(buf[0]))</span><br><span style="color: hsl(120, 100%, 40%);">+ return -EINVAL;</span><br><span style="color: hsl(120, 100%, 40%);">+ return buf[1];</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%);">+ return buf[0];</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! Print a human readable name of the cell identifier to the char buffer.</span><br><span> * This is useful both for struct gsm0808_cell_id and struct gsm0808_cell_id_list2.</span><br><span> * See also gsm0808_cell_id_name() and gsm0808_cell_id_list_name().</span><br><span>diff --git a/src/gsm/libosmogsm.map b/src/gsm/libosmogsm.map</span><br><span>index 32e4ce9..217dcc3 100644</span><br><span>--- a/src/gsm/libosmogsm.map</span><br><span>+++ b/src/gsm/libosmogsm.map</span><br><span>@@ -157,6 +157,8 @@</span><br><span> gsm0808_create_cipher;</span><br><span> gsm0808_create_cipher_complete;</span><br><span> gsm0808_create_cipher_reject;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_create_cipher_reject_ext;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm0808_get_cipher_reject_cause;</span><br><span> gsm0808_create_classmark_request;</span><br><span> gsm0808_create_classmark_update;</span><br><span> gsm0808_create_clear_command;</span><br><span>diff --git a/tests/gsm0808/gsm0808_test.c b/tests/gsm0808/gsm0808_test.c</span><br><span>index 671b839..197ec06 100644</span><br><span>--- a/tests/gsm0808/gsm0808_test.c</span><br><span>+++ b/tests/gsm0808/gsm0808_test.c</span><br><span>@@ -250,14 +250,55 @@</span><br><span> msgb_free(l3);</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+static inline void parse_cipher_reject(struct msgb *msg, uint8_t exp)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ struct tlv_parsed tp;</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%);">+ /* skip header and message type so we can parse Cause IE directly */</span><br><span style="color: hsl(120, 100%, 40%);">+ msg->l2h = msgb_data(msg) + sizeof(struct bssmap_header) + 1;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = osmo_bssap_tlv_parse(&tp, msg->l2h, msgb_l2len(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("FIXME: failed (%d) to parse created message %s\n", rc, msgb_hexdump(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ rc = gsm0808_get_cipher_reject_cause(&tp);</span><br><span style="color: hsl(120, 100%, 40%);">+ if (rc < 0)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("FIXME: failed (%s) to extract Cause from created message %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ strerror(-rc), msgb_hexdump(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ if (exp != (enum gsm0808_cause)rc)</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("FIXME: wrong Cause %d != %u (" OSMO_BIN_SPEC ") extracted from created message %s\n",</span><br><span style="color: hsl(120, 100%, 40%);">+ rc, exp, OSMO_BIT_PRINT(exp), msgb_hexdump(msg));</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> static void test_create_cipher_reject()</span><br><span> {</span><br><span> static const uint8_t res[] = { 0x00, 0x04, 0x59, 0x04, 0x01, 0x23 };</span><br><span style="color: hsl(120, 100%, 40%);">+ enum gsm0808_cause cause = GSM0808_CAUSE_CCCH_OVERLOAD;</span><br><span> struct msgb *msg;</span><br><span> </span><br><span> printf("Testing creating Cipher Reject\n");</span><br><span style="color: hsl(0, 100%, 40%);">- msg = gsm0808_create_cipher_reject(GSM0808_CAUSE_CCCH_OVERLOAD);</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = gsm0808_create_cipher_reject(cause);</span><br><span> VERIFY(msg, res, ARRAY_SIZE(res));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ parse_cipher_reject(msg, cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ msgb_free(msg);</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 void test_create_cipher_reject_ext()</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ static const uint8_t res[] = { 0x00, 0x05, 0x59, 0x04, 0x02, 0xd0, 0xFA };</span><br><span style="color: hsl(120, 100%, 40%);">+ uint8_t cause = 0xFA;</span><br><span style="color: hsl(120, 100%, 40%);">+ struct msgb *msg;</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ printf("Testing creating Cipher Reject (extended)\n");</span><br><span style="color: hsl(120, 100%, 40%);">+ msg = gsm0808_create_cipher_reject_ext(GSM0808_CAUSE_CLASS_INVAL, cause);</span><br><span style="color: hsl(120, 100%, 40%);">+ VERIFY(msg, res, ARRAY_SIZE(res));</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+ parse_cipher_reject(msg, cause);</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> msgb_free(msg);</span><br><span> }</span><br><span> </span><br><span>@@ -1738,6 +1779,7 @@</span><br><span> test_create_cipher();</span><br><span> test_create_cipher_complete();</span><br><span> test_create_cipher_reject();</span><br><span style="color: hsl(120, 100%, 40%);">+ test_create_cipher_reject_ext();</span><br><span> test_create_cm_u();</span><br><span> test_create_sapi_reject();</span><br><span> test_create_ass();</span><br><span>diff --git a/tests/gsm0808/gsm0808_test.ok b/tests/gsm0808/gsm0808_test.ok</span><br><span>index 58bc509..a48cf1d 100644</span><br><span>--- a/tests/gsm0808/gsm0808_test.ok</span><br><span>+++ b/tests/gsm0808/gsm0808_test.ok</span><br><span>@@ -8,6 +8,7 @@</span><br><span> Testing creating Chipher Mode Command</span><br><span> Testing creating Cipher Complete</span><br><span> Testing creating Cipher Reject</span><br><span style="color: hsl(120, 100%, 40%);">+Testing creating Cipher Reject (extended)</span><br><span> Testing creating CM U</span><br><span> Testing creating SAPI Reject</span><br><span> Testing creating Assignment Request</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/11601">change 11601</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/11601"/><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: Id5509b94a18180a44f45300caaa02b843c166fa3 </div>
<div style="display:none"> Gerrit-Change-Number: 11601 </div>
<div style="display:none"> Gerrit-PatchSet: 8 </div>
<div style="display:none"> Gerrit-Owner: Max <msuraev@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: Max <msuraev@sysmocom.de> </div>
<div style="display:none"> Gerrit-CC: Vadim Yanitskiy <axilirator@gmail.com> </div>