bucketking657 has uploaded this change for review.

View Change

gsm: fix one-byte overflow in BCD number encoders

gsm48_encode_bcd_number() limits the L octet to max_len, but callers
passed the whole buffer size, so a number one or two digits over the
spec maximum wrote one byte past the buffer. Pass sizeof() - 1, and
compute the length in an int so that it cannot wrap. Add tests.

Fixes: OS#7126
Change-Id: I99521d30896f3d58ecfb28de290bce7e31388fca
---
M src/gsm/gsm0411_utils.c
M src/gsm/gsm0808_utils.c
M src/gsm/gsm48_ie.c
M src/gsm/gsup.c
M tests/gsm0408/gsm0408_test.c
M tests/gsm0408/gsm0408_test.ok
M tests/gsm0808/gsm0808_test.c
M tests/gsm0808/gsm0808_test.ok
8 files changed, 142 insertions(+), 10 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/42/44142/1
diff --git a/src/gsm/gsm0411_utils.c b/src/gsm/gsm0411_utils.c
index 470b017..5a9aa7c 100644
--- a/src/gsm/gsm0411_utils.c
+++ b/src/gsm/gsm0411_utils.c
@@ -315,7 +315,7 @@
/* prevent buffer overflows */
if (strlen(number) > 20)
number = "";
- len_in_bytes = gsm48_encode_bcd_number(oa, oa_len, 1, number);
+ len_in_bytes = gsm48_encode_bcd_number(oa, oa_len - 1, 1, number);
/* GSM 03.40 tells us the length is in 'useful semi-octets' */
oa[0] = strlen(number) & 0xff;
}
diff --git a/src/gsm/gsm0808_utils.c b/src/gsm/gsm0808_utils.c
index d7bc275..74fdf93 100644
--- a/src/gsm/gsm0808_utils.c
+++ b/src/gsm/gsm0808_utils.c
@@ -2375,7 +2375,7 @@
OSMO_ASSERT(msg);
OSMO_ASSERT(msisdn);

- rc = gsm48_encode_bcd_number(bcd_lv, sizeof(bcd_lv), 0, msisdn);
+ rc = gsm48_encode_bcd_number(bcd_lv, sizeof(bcd_lv) - 1, 0, msisdn);
if (rc < 1)
return 0;

diff --git a/src/gsm/gsm48_ie.c b/src/gsm/gsm48_ie.c
index e33e672..ed2b6b8 100644
--- a/src/gsm/gsm48_ie.c
+++ b/src/gsm/gsm48_ie.c
@@ -137,7 +137,8 @@

/*! convert a ASCII phone number to 'called/calling/connect party BCD number'
* \param[out] bcd_lv Caller-provided output buffer
- * \param[in] max_len Maximum Length of \a bcd_lv
+ * \param[in] max_len Maximum value of the L octet; \a bcd_lv must have
+ * room for at least max_len + 1 bytes
* \param[in] h_len Length of an optional heder between L and V portion
* \param[in] input phone number as 0-terminated ASCII
* \returns number of bytes used in \a bcd_lv; negative on error
@@ -151,16 +152,18 @@
int h_len, const char *input)
{
int in_len = strlen(input);
+ int len;
int i;
uint8_t *bcd_cur = bcd_lv + 1 + h_len;

/* two digits per byte, plus type byte */
- bcd_lv[0] = in_len/2 + h_len;
+ len = in_len/2 + h_len;
if (in_len % 2)
- bcd_lv[0]++;
+ len++;

- if (bcd_lv[0] > max_len)
+ if (len > max_len)
return -EIO;
+ bcd_lv[0] = len;

for (i = 0; i < in_len; i++) {
int rc = asc_to_bcd(input[i]);
@@ -463,7 +466,7 @@
lv[1] |= called->type << 4;

/* octet 4..N, octet 2 */
- ret = gsm48_encode_bcd_number(lv, sizeof(lv), 1, called->number);
+ ret = gsm48_encode_bcd_number(lv, sizeof(lv) - 1, 1, called->number);
if (ret < 0)
return ret;

@@ -531,7 +534,7 @@
lv[1] |= 0x80;

/* octet 4..N, octet 2 */
- ret = gsm48_encode_bcd_number(lv, sizeof(lv), h_len, callerid->number);
+ ret = gsm48_encode_bcd_number(lv, sizeof(lv) - 1, h_len, callerid->number);
if (ret < 0)
return ret;

diff --git a/src/gsm/gsup.c b/src/gsm/gsup.c
index 1e4ee6a..49dcd9c 100644
--- a/src/gsm/gsup.c
+++ b/src/gsm/gsup.c
@@ -807,7 +807,7 @@

msgb_v_put(msg, gsup_msg->message_type);

- bcd_len = gsm48_encode_bcd_number(bcd_buf, sizeof(bcd_buf), 0,
+ bcd_len = gsm48_encode_bcd_number(bcd_buf, sizeof(bcd_buf) - 1, 0,
gsup_msg->imsi);

if (bcd_len <= 0 || bcd_len > sizeof(bcd_buf))
diff --git a/tests/gsm0408/gsm0408_test.c b/tests/gsm0408/gsm0408_test.c
index 5566b7c..cf2da53 100644
--- a/tests/gsm0408/gsm0408_test.c
+++ b/tests/gsm0408/gsm0408_test.c
@@ -1496,6 +1496,28 @@
.enc_buf_lim = 9,
},
{
+ .test_name = "17-digit number, L octet equals max_len (OS#7126)",
+
+ /* Encoding test (max_len limits the L octet, not the buffer) */
+ .enc_ascii = "12345678901234567",
+ .enc_hex = "092143658709214365f7",
+ .enc_rc = 10,
+
+ /* Buffer length limitations */
+ .enc_buf_lim = 9,
+ },
+ {
+ .test_name = "19-digit number, L octet exceeds max_len (OS#7126)",
+
+ /* Encoding test (not enough room in buffer) */
+ .enc_ascii = "1234567890123456789",
+ .enc_hex = "", /* nothing */
+ .enc_rc = -EIO,
+
+ /* Buffer length limitations */
+ .enc_buf_lim = 9,
+ },
+ {
.test_name = "LV incorrect length",
.dec_hex = "05214365", /* should be 0x03 */
.dec_ascii = "(none)",
@@ -1545,7 +1567,7 @@
if (test->enc_buf_lim)
buf_len = test->enc_buf_lim;
else
- buf_len = sizeof(buf_enc);
+ buf_len = sizeof(buf_enc) - 1;

printf(" - Encoding ASCII (buffer limit=%zu) '%s'...\n",
test->enc_buf_lim, test->enc_ascii);
@@ -1587,6 +1609,63 @@
printf("\n");
}

+static void test_bcd_number_ie(const char *name,
+ int (*enc)(struct msgb *msg, const struct gsm_mncc_number *num),
+ unsigned int num_digits, bool octet_3a)
+{
+ struct gsm_mncc_number num = { .screen = octet_3a ? 1 : 0 };
+ struct msgb *msg = msgb_alloc(128, __func__);
+ int rc;
+
+ OSMO_ASSERT(msg);
+ OSMO_ASSERT(num_digits < sizeof(num.number));
+ memset(num.number, '1', num_digits);
+
+ rc = enc(msg, &num);
+ printf("- %s, %u digits%s: rc=%d IE='%s'\n", name, num_digits,
+ octet_3a ? " (with octet 3a)" : "", rc,
+ osmo_hexdump_nospc(msgb_data(msg), msgb_length(msg)));
+
+ msgb_free(msg);
+}
+
+/* OS#7126: neither the L octet nor the IE buffers may overflow */
+static void test_bcd_number_encode_limits(void)
+{
+ char digits[512];
+ uint8_t buf[256];
+ int rc;
+
+ printf("BCD number encoding limits test\n");
+
+ /* The L octet must not wrap: 510 digits give L = 255, 511 give 256 */
+ memset(digits, '1', 510);
+ digits[510] = '\0';
+ rc = gsm48_encode_bcd_number(buf, sizeof(buf) - 1, 0, digits);
+ printf("- 510 digits, max_len=%zu: rc=%d\n", sizeof(buf) - 1, rc);
+ memset(digits, '1', 511);
+ digits[511] = '\0';
+ rc = gsm48_encode_bcd_number(buf, sizeof(buf) - 1, 0, digits);
+ printf("- 511 digits, max_len=%zu: rc=%d\n", sizeof(buf) - 1, rc);
+
+ /* TS 24.008 10.5.4.9: Calling party BCD number, at most 14 octets */
+ test_bcd_number_ie("Calling", gsm48_encode_calling, 22, false);
+ test_bcd_number_ie("Calling", gsm48_encode_calling, 23, false);
+ test_bcd_number_ie("Calling", gsm48_encode_calling, 20, true);
+ test_bcd_number_ie("Calling", gsm48_encode_calling, 21, true);
+ /* TS 24.008 10.5.4.13: Connected number, at most 14 octets */
+ test_bcd_number_ie("Connected", gsm48_encode_connected, 22, false);
+ test_bcd_number_ie("Connected", gsm48_encode_connected, 23, false);
+ /* TS 24.008 10.5.4.21b: Redirecting party BCD number, at most 19 octets */
+ test_bcd_number_ie("Redirecting", gsm48_encode_redirecting, 32, false);
+ test_bcd_number_ie("Redirecting", gsm48_encode_redirecting, 30, true);
+ test_bcd_number_ie("Redirecting", gsm48_encode_redirecting, 31, true);
+ /* TS 24.008 10.5.4.7: Called party BCD number, limited by lv[18] */
+ test_bcd_number_ie("Called", gsm48_encode_called, 32, false);
+
+ printf("\n");
+}
+
struct {
int range;
int arfcns_num;
@@ -2026,6 +2105,7 @@
test_mid_decode_zero_length();
test_struct_mobile_identity();
test_bcd_number_encode_decode();
+ test_bcd_number_encode_limits();
test_ra_cap();
test_lai_encode_decode();
test_osmo_routing_area_id();
diff --git a/tests/gsm0408/gsm0408_test.ok b/tests/gsm0408/gsm0408_test.ok
index 3580591..f9838f0 100644
--- a/tests/gsm0408/gsm0408_test.ok
+++ b/tests/gsm0408/gsm0408_test.ok
@@ -229,6 +229,14 @@
- Decoding HEX (buffer limit=16) '0a21436587092143658709'...
- Expected: (rc=-28) '123456789012345'
- Actual: (rc=-28) '123456789012345'
+- Running test: 17-digit number, L octet equals max_len (OS#7126)
+ - Encoding ASCII (buffer limit=9) '12345678901234567'...
+ - Expected: (rc=10) '092143658709214365f7'
+ - Actual: (rc=10) '092143658709214365f7'
+- Running test: 19-digit number, L octet exceeds max_len (OS#7126)
+ - Encoding ASCII (buffer limit=9) '1234567890123456789'...
+ - Expected: (rc=-5) ''
+ - Actual: (rc=-5) ''
- Running test: LV incorrect length
- Decoding HEX (buffer limit=0) '05214365'...
- Expected: (rc=-22) '(none)'
@@ -245,6 +253,20 @@
- Expected: (rc=-28) '123'
- Actual: (rc=-28) '123'

+BCD number encoding limits test
+- 510 digits, max_len=255: rc=256
+- 511 digits, max_len=255: rc=-5
+- Calling, 22 digits: rc=0 IE='5c0c801111111111111111111111'
+- Calling, 23 digits: rc=-5 IE=''
+- Calling, 20 digits (with octet 3a): rc=0 IE='5c0c008111111111111111111111'
+- Calling, 21 digits (with octet 3a): rc=-5 IE=''
+- Connected, 22 digits: rc=0 IE='4c0c801111111111111111111111'
+- Connected, 23 digits: rc=-5 IE=''
+- Redirecting, 32 digits: rc=0 IE='74118011111111111111111111111111111111'
+- Redirecting, 30 digits (with octet 3a): rc=0 IE='74110081111111111111111111111111111111'
+- Redirecting, 31 digits (with octet 3a): rc=-5 IE=''
+- Called, 32 digits: rc=0 IE='5e118011111111111111111111111111111111'
+
Constructed RA:
077-121-666-5
MCC+MNC in BCD: 70 17 21
diff --git a/tests/gsm0808/gsm0808_test.c b/tests/gsm0808/gsm0808_test.c
index 8ebbd4b..cafea50 100644
--- a/tests/gsm0808/gsm0808_test.c
+++ b/tests/gsm0808/gsm0808_test.c
@@ -477,6 +477,29 @@
OSMO_ASSERT(rc == 5);
}

+/* OS#7126: TS 48.008 3.2.2.101 allows at most 10 octets of MSISDN digits */
+static void test_gsm0808_enc_msisdn_limits(void)
+{
+ static const char *msisdns[] = {
+ "12345678901234567890", /* 20 digits, the maximum */
+ "123456789012345678901", /* 21 digits, too long */
+ };
+ unsigned int i;
+
+ printf("Testing encoding MSISDN length limits\n");
+
+ for (i = 0; i < ARRAY_SIZE(msisdns); i++) {
+ struct msgb *msg = msgb_alloc(64, __func__);
+ uint8_t rc;
+
+ OSMO_ASSERT(msg);
+ rc = gsm0808_enc_msisdn(msg, msisdns[i]);
+ printf("- %zu digits: rc=%u IE='%s'\n", strlen(msisdns[i]), rc,
+ osmo_hexdump_nospc(msgb_data(msg), msgb_length(msg)));
+ msgb_free(msg);
+ }
+}
+
static void test_create_ass(void)
{
static const uint8_t res1[] =
@@ -2822,6 +2845,7 @@

test_dec_confusion();
test_dec_perform_location_report_sys5891();
+ test_gsm0808_enc_msisdn_limits();

printf("Done\n");
return EXIT_SUCCESS;
diff --git a/tests/gsm0808/gsm0808_test.ok b/tests/gsm0808/gsm0808_test.ok
index 2329fcd..b3d4cae 100644
--- a/tests/gsm0808/gsm0808_test.ok
+++ b/tests/gsm0808/gsm0808_test.ok
@@ -917,4 +917,7 @@
Diagnostics error bit location 15 (Reserved value)
Diagnostics message that provoked the error: 00 03 25 03 25
Testing decoding Perform Location Report SYS#5891
+Testing encoding MSISDN length limits
+- 20 digits: rc=12 IE='7b0a21436587092143658709'
+- 21 digits: rc=0 IE=''
Done

To view, visit change 44142. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-MessageType: newchange
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: I99521d30896f3d58ecfb28de290bce7e31388fca
Gerrit-Change-Number: 44142
Gerrit-PatchSet: 1
Gerrit-Owner: bucketking657 <joshuashilts@gmail.com>