<p>fixeria <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/libosmocore/+/22544">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  Jenkins Builder: Verified
  laforge: Looks good to me, but someone else must approve
  pespin: Looks good to me, approved

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">gsm_7bit_encode_n(): fix integer overflow in gsm_septets2octets()<br><br>Using 'uint8_t' for the length argument is definitely a bad idea.<br>Because of this, packing more than 255 septets would not work as<br>expected.  Deprecate the old function and use 'size_t' instead.<br><br>Change-Id: Ib1aac538afeb0a5c76a1df472d555139a496e12e<br>---<br>M include/osmocom/gsm/gsm_utils.h<br>M src/gsm/gsm_utils.c<br>M src/gsm/libosmogsm.map<br>M tests/sms/sms_test.c<br>M tests/sms/sms_test.ok<br>5 files changed, 20 insertions(+), 15 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/include/osmocom/gsm/gsm_utils.h b/include/osmocom/gsm/gsm_utils.h</span><br><span>index de63434..0909006 100644</span><br><span>--- a/include/osmocom/gsm/gsm_utils.h</span><br><span>+++ b/include/osmocom/gsm/gsm_utils.h</span><br><span>@@ -110,7 +110,10 @@</span><br><span> int gsm_7bit_encode_n_ussd(uint8_t *result, size_t n, const char *data, int *octets_written);</span><br><span> </span><br><span> /* the four functions below are helper functions and here for the unit test */</span><br><span style="color: hsl(0, 100%, 40%);">-int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding);</span><br><span style="color: hsl(120, 100%, 40%);">+int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)</span><br><span style="color: hsl(120, 100%, 40%);">+        OSMO_DEPRECATED("This function is unable to handle more than 255 septets, "</span><br><span style="color: hsl(120, 100%, 40%);">+                 "use gsm_septet_pack() instead.");</span><br><span style="color: hsl(120, 100%, 40%);">+int gsm_septet_pack(uint8_t *result, const uint8_t *rdata, size_t septet_len, uint8_t padding);</span><br><span> int gsm_septet_encode(uint8_t *result, const char *data);</span><br><span> uint8_t gsm_get_octet_len(const uint8_t sept_len);</span><br><span> int gsm_7bit_decode_n_hdr(char *decoded, size_t n, const uint8_t *user_data, uint8_t length, uint8_t ud_hdr_ind);</span><br><span>diff --git a/src/gsm/gsm_utils.c b/src/gsm/gsm_utils.c</span><br><span>index ae77a9d..07e082d 100644</span><br><span>--- a/src/gsm/gsm_utils.c</span><br><span>+++ b/src/gsm/gsm_utils.c</span><br><span>@@ -324,7 +324,7 @@</span><br><span>  *  \param[in] septet_len Length of \a rdata</span><br><span>  *  \param[in] padding padding bits at start</span><br><span>  *  \returns number of bytes used in \a result */</span><br><span style="color: hsl(0, 100%, 40%);">-int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)</span><br><span style="color: hsl(120, 100%, 40%);">+int gsm_septet_pack(uint8_t *result, const uint8_t *rdata, size_t septet_len, uint8_t padding)</span><br><span> {</span><br><span>     int i = 0, z = 0;</span><br><span>    uint8_t cb, nb;</span><br><span>@@ -369,6 +369,12 @@</span><br><span>       return z;</span><br><span> }</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+/*! Backwards compatibility wrapper for gsm_septets_pack(), deprecated. */</span><br><span style="color: hsl(120, 100%, 40%);">+int gsm_septets2octets(uint8_t *result, const uint8_t *rdata, uint8_t septet_len, uint8_t padding)</span><br><span style="color: hsl(120, 100%, 40%);">+{</span><br><span style="color: hsl(120, 100%, 40%);">+ return gsm_septet_pack(result, rdata, septet_len, padding);</span><br><span style="color: hsl(120, 100%, 40%);">+}</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> /*! GSM 7-bit alphabet TS 03.38 6.2.1 Character packing</span><br><span>  *  \param[out] result Caller-provided output buffer</span><br><span>  *  \param[in] n Maximum length of \a result in bytes</span><br><span>@@ -393,7 +399,7 @@</span><br><span>           y = max_septets;</span><br><span>     }</span><br><span> </span><br><span style="color: hsl(0, 100%, 40%);">-   o = gsm_septets2octets(result, rdata, y, 0);</span><br><span style="color: hsl(120, 100%, 40%);">+  o = gsm_septet_pack(result, rdata, y, 0);</span><br><span> </span><br><span>        if (octets)</span><br><span>          *octets = o;</span><br><span>diff --git a/src/gsm/libosmogsm.map b/src/gsm/libosmogsm.map</span><br><span>index c314c20..584d761 100644</span><br><span>--- a/src/gsm/libosmogsm.map</span><br><span>+++ b/src/gsm/libosmogsm.map</span><br><span>@@ -478,6 +478,7 @@</span><br><span> </span><br><span> gsm_milenage;</span><br><span> gsm_septet_encode;</span><br><span style="color: hsl(120, 100%, 40%);">+gsm_septet_pack;</span><br><span> gsm_septets2octets;</span><br><span> </span><br><span> lapd_dl_exit;</span><br><span>diff --git a/tests/sms/sms_test.c b/tests/sms/sms_test.c</span><br><span>index c7f47e2..3e14529 100644</span><br><span>--- a/tests/sms/sms_test.c</span><br><span>+++ b/tests/sms/sms_test.c</span><br><span>@@ -384,7 +384,7 @@</span><br><span>  memcpy(tmp, septet_data, concatenated_part1_septet_length);</span><br><span> </span><br><span>      /* In our case: test_multiple_decode[0].ud_hdr_ind equals number of padding bits*/</span><br><span style="color: hsl(0, 100%, 40%);">-      octet_length = gsm_septets2octets(coded, tmp, concatenated_part1_septet_length, test_multiple_encode[0].ud_hdr_ind);</span><br><span style="color: hsl(120, 100%, 40%);">+  octet_length = gsm_septet_pack(coded, tmp, concatenated_part1_septet_length, test_multiple_encode[0].ud_hdr_ind);</span><br><span> </span><br><span>        /* copy header */</span><br><span>    memset(tmp, 0x42, sizeof(tmp));</span><br><span>@@ -402,7 +402,7 @@</span><br><span>        memcpy(tmp, septet_data + concatenated_part1_septet_length, concatenated_part2_septet_length);</span><br><span> </span><br><span>   /* In our case: test_multiple_decode[1].ud_hdr_ind equals number of padding bits*/</span><br><span style="color: hsl(0, 100%, 40%);">-      octet_length = gsm_septets2octets(coded, tmp, concatenated_part2_septet_length, test_multiple_encode[1].ud_hdr_ind);</span><br><span style="color: hsl(120, 100%, 40%);">+  octet_length = gsm_septet_pack(coded, tmp, concatenated_part2_septet_length, test_multiple_encode[1].ud_hdr_ind);</span><br><span> </span><br><span>        /* copy header */</span><br><span>    memset(tmp, 0x42, sizeof(tmp));</span><br><span>diff --git a/tests/sms/sms_test.ok b/tests/sms/sms_test.ok</span><br><span>index 724c166..de1fce3 100644</span><br><span>--- a/tests/sms/sms_test.ok</span><br><span>+++ b/tests/sms/sms_test.ok</span><br><span>@@ -21,20 +21,15 @@</span><br><span> </span><br><span> Running test_enc_large_msg</span><br><span> gsm_7bit_encode_n(len=2048) processed 2048 septets (expected 2048): OK</span><br><span style="color: hsl(0, 100%, 40%);">-gsm_7bit_encode_n(len=2048) used 0 octets in the buffer (expected 1792): FAIL</span><br><span style="color: hsl(0, 100%, 40%);">- Unexpected chunk at enc_buf[0:7]: 00 00 00 00 00 00 00 </span><br><span style="color: hsl(120, 100%, 40%);">+gsm_7bit_encode_n(len=2048) used 1792 octets in the buffer (expected 1792): OK</span><br><span> gsm_7bit_encode_n(len=1024) processed 1024 septets (expected 1024): OK</span><br><span style="color: hsl(0, 100%, 40%);">-gsm_7bit_encode_n(len=1024) used 0 octets in the buffer (expected 896): FAIL</span><br><span style="color: hsl(0, 100%, 40%);">-   Unexpected chunk at enc_buf[0:7]: 00 00 00 00 00 00 00 </span><br><span style="color: hsl(120, 100%, 40%);">+gsm_7bit_encode_n(len=1024) used 896 octets in the buffer (expected 896): OK</span><br><span> gsm_7bit_encode_n(len=555) processed 555 septets (expected 555): OK</span><br><span style="color: hsl(0, 100%, 40%);">-gsm_7bit_encode_n(len=555) used 38 octets in the buffer (expected 486): FAIL</span><br><span style="color: hsl(0, 100%, 40%);">-        Unexpected chunk at enc_buf[35:6]: c1 60 10 00 00 00 </span><br><span style="color: hsl(120, 100%, 40%);">+gsm_7bit_encode_n(len=555) used 486 octets in the buffer (expected 486): OK</span><br><span> gsm_7bit_encode_n(len=512) processed 512 septets (expected 512): OK</span><br><span style="color: hsl(0, 100%, 40%);">-gsm_7bit_encode_n(len=512) used 0 octets in the buffer (expected 448): FAIL</span><br><span style="color: hsl(0, 100%, 40%);">-    Unexpected chunk at enc_buf[0:7]: 00 00 00 00 00 00 00 </span><br><span style="color: hsl(120, 100%, 40%);">+gsm_7bit_encode_n(len=512) used 448 octets in the buffer (expected 448): OK</span><br><span> gsm_7bit_encode_n(len=260) processed 260 septets (expected 260): OK</span><br><span style="color: hsl(0, 100%, 40%);">-gsm_7bit_encode_n(len=260) used 4 octets in the buffer (expected 228): FAIL</span><br><span style="color: hsl(0, 100%, 40%);">-  Unexpected chunk at enc_buf[0:6]: c1 60 30 08 00 00 </span><br><span style="color: hsl(120, 100%, 40%);">+gsm_7bit_encode_n(len=260) used 228 octets in the buffer (expected 228): OK</span><br><span> gsm_7bit_encode_n(len=255) processed 255 septets (expected 255): OK</span><br><span> gsm_7bit_encode_n(len=255) used 224 octets in the buffer (expected 224): OK</span><br><span> gsm_7bit_encode_n(len=250) processed 250 septets (expected 250): OK</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/libosmocore/+/22544">change 22544</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/libosmocore/+/22544"/><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-Change-Id: Ib1aac538afeb0a5c76a1df472d555139a496e12e </div>
<div style="display:none"> Gerrit-Change-Number: 22544 </div>
<div style="display:none"> Gerrit-PatchSet: 3 </div>
<div style="display:none"> Gerrit-Owner: fixeria <vyanitskiy@sysmocom.de> </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: pespin <pespin@sysmocom.de> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>