Skip to content

Commit 312f204

Browse files
itamarogpsheadmdickinson
authored andcommitted
gh-95778: Correctly pre-check for int-to-str conversion (GH-96537) (#96563)
Summary: cherry-picked the upstream 3.10 backport ``` git cherry-pick 8f0fa4b eace09e ``` this one is python/cpython#96563 original commit message below -------- Converting a large enough `int` to a decimal string raises `ValueError` as expected. However, the raise comes _after_ the quadratic-time base-conversion algorithm has run to completion. For effective DOS prevention, we need some kind of check before entering the quadratic-time loop. Oops! =) The quick fix: essentially we catch _most_ values that exceed the threshold up front. Those that slip through will still be on the small side (read: sufficiently fast), and will get caught by the existing check so that the limit remains exact. The justification for the current check. The C code check is: ```c max_str_digits / (3 * PyLong_SHIFT) <= (size_a - 11) / 10 ``` In GitHub markdown math-speak, writing $M$ for `max_str_digits`, $L$ for `PyLong_SHIFT` and $s$ for `size_a`, that check is: $$\left\lfloor\frac{M}{3L}\right\rfloor \le \left\lfloor\frac{s - 11}{10}\right\rfloor$$ From this it follows that $$\frac{M}{3L} < \frac{s-1}{10}$$ hence that $$\frac{L(s-1)}{M} > \frac{10}{3} > \log_2(10).$$ So $$2^{L(s-1)} > 10^M.$$ But our input integer $a$ satisfies $|a| \ge 2^{L(s-1)}$, so $|a|$ is larger than $10^M$. This shows that we don't accidentally capture anything _below_ the intended limit in the check. <!-- gh-issue-number: gh-95778 --> * Issue: gh-95778 <!-- /gh-issue-number --> (cherry picked from commit b126196) Reviewed By: alexmalyshev Differential Revision: D39369517 fbshipit-source-id: 750f9c3 Co-authored-by: Gregory P. Smith [Google LLC] <greg@krypto.org> Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
1 parent fcfb677 commit 312f204

File tree

4 files changed

+109
-7
lines changed

4 files changed

+109
-7
lines changed

Include/internal/pycore_long.h

+2-2
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@ extern "C" {
1818
* everyone's existing deployed numpy test suite passes before
1919
* https://github.com/numpy/numpy/issues/22098 is widely available.
2020
*
21-
* $ python -m timeit -s 's = * "1"*4300' 'int(s)'
21+
* $ python -m timeit -s 's = "1"*4300' 'int(s)'
2222
* 2000 loops, best of 5: 125 usec per loop
23-
* $ python -m timeit -s 's = * "1"*4300; v = int(s)' 'str(v)'
23+
* $ python -m timeit -s 's = "1"*4300; v = int(s)' 'str(v)'
2424
* 1000 loops, best of 5: 311 usec per loop
2525
* (zen2 cloud VM)
2626
*

Lib/test/test_int.py

+84
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
import sys
2+
import time
23

34
import unittest
45
from test import support
@@ -623,6 +624,89 @@ def test_max_str_digits(self):
623624
with self.assertRaises(ValueError):
624625
str(i)
625626

627+
@unittest.skip("timing-sensitive tests are evil, especially under JIT + inliner")
628+
def test_denial_of_service_prevented_int_to_str(self):
629+
"""Regression test: ensure we fail before performing O(N**2) work."""
630+
maxdigits = sys.get_int_max_str_digits()
631+
assert maxdigits < 50_000, maxdigits # A test prerequisite.
632+
get_time = time.process_time
633+
if get_time() <= 0: # some platforms like WASM lack process_time()
634+
get_time = time.monotonic
635+
636+
huge_int = int(f'0x{"c"*65_000}', base=16) # 78268 decimal digits.
637+
digits = 78_268
638+
with support.adjust_int_max_str_digits(digits):
639+
start = get_time()
640+
huge_decimal = str(huge_int)
641+
seconds_to_convert = get_time() - start
642+
self.assertEqual(len(huge_decimal), digits)
643+
# Ensuring that we chose a slow enough conversion to measure.
644+
# It takes 0.1 seconds on a Zen based cloud VM in an opt build.
645+
if seconds_to_convert < 0.005:
646+
raise unittest.SkipTest('"slow" conversion took only '
647+
f'{seconds_to_convert} seconds.')
648+
649+
# We test with the limit almost at the size needed to check performance.
650+
# The performant limit check is slightly fuzzy, give it a some room.
651+
with support.adjust_int_max_str_digits(int(.995 * digits)):
652+
with self.assertRaises(ValueError) as err:
653+
start = get_time()
654+
str(huge_int)
655+
seconds_to_fail_huge = get_time() - start
656+
self.assertIn('conversion', str(err.exception))
657+
self.assertLess(seconds_to_fail_huge, seconds_to_convert/8)
658+
659+
# Now we test that a conversion that would take 30x as long also fails
660+
# in a similarly fast fashion.
661+
extra_huge_int = int(f'0x{"c"*500_000}', base=16) # 602060 digits.
662+
with self.assertRaises(ValueError) as err:
663+
start = get_time()
664+
# If not limited, 8 seconds said Zen based cloud VM.
665+
str(extra_huge_int)
666+
seconds_to_fail_extra_huge = get_time() - start
667+
self.assertIn('conversion', str(err.exception))
668+
self.assertLess(seconds_to_fail_extra_huge, seconds_to_convert/8)
669+
670+
@unittest.skip("timing-sensitive tests are evil, especially under JIT + inliner")
671+
def test_denial_of_service_prevented_str_to_int(self):
672+
"""Regression test: ensure we fail before performing O(N**2) work."""
673+
maxdigits = sys.get_int_max_str_digits()
674+
assert maxdigits < 100_000, maxdigits # A test prerequisite.
675+
get_time = time.process_time
676+
if get_time() <= 0: # some platforms like WASM lack process_time()
677+
get_time = time.monotonic
678+
679+
digits = 133700
680+
huge = '8'*digits
681+
with support.adjust_int_max_str_digits(digits):
682+
start = get_time()
683+
int(huge)
684+
seconds_to_convert = get_time() - start
685+
# Ensuring that we chose a slow enough conversion to measure.
686+
# It takes 0.1 seconds on a Zen based cloud VM in an opt build.
687+
if seconds_to_convert < 0.005:
688+
raise unittest.SkipTest('"slow" conversion took only '
689+
f'{seconds_to_convert} seconds.')
690+
691+
with support.adjust_int_max_str_digits(digits - 1):
692+
with self.assertRaises(ValueError) as err:
693+
start = get_time()
694+
int(huge)
695+
seconds_to_fail_huge = get_time() - start
696+
self.assertIn('conversion', str(err.exception))
697+
self.assertLess(seconds_to_fail_huge, seconds_to_convert/8)
698+
699+
# Now we test that a conversion that would take 30x as long also fails
700+
# in a similarly fast fashion.
701+
extra_huge = '7'*1_200_000
702+
with self.assertRaises(ValueError) as err:
703+
start = get_time()
704+
# If not limited, 8 seconds in the Zen based cloud VM.
705+
int(extra_huge)
706+
seconds_to_fail_extra_huge = get_time() - start
707+
self.assertIn('conversion', str(err.exception))
708+
self.assertLess(seconds_to_fail_extra_huge, seconds_to_convert/8)
709+
626710
def test_power_of_two_bases_unlimited(self):
627711
"""The limit does not apply to power of 2 bases."""
628712
maxdigits = sys.get_int_max_str_digits()

Misc/NEWS.d/next/Security/2022-08-07-16-53-38.gh-issue-95778.ch010gps.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ limitation <int_max_str_digits>` documentation. The default limit is 4300
1111
digits in string form.
1212

1313
Patch by Gregory P. Smith [Google] and Christian Heimes [Red Hat] with feedback
14-
from Victor Stinner, Thomas Wouters, Steve Dower, and Ned Deily.
14+
from Victor Stinner, Thomas Wouters, Steve Dower, Ned Deily, and Mark Dickinson.

Objects/longobject.c

+22-4
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,8 @@ _Py_IDENTIFIER(big);
3636
#define IS_SMALL_INT(ival) (-NSMALLNEGINTS <= (ival) && (ival) < NSMALLPOSINTS)
3737
#define IS_SMALL_UINT(ival) ((ival) < NSMALLPOSINTS)
3838

39-
#define _MAX_STR_DIGITS_ERROR_FMT "Exceeds the limit (%d) for integer string conversion: value has %zd digits"
39+
#define _MAX_STR_DIGITS_ERROR_FMT_TO_INT "Exceeds the limit (%d) for integer string conversion: value has %zd digits"
40+
#define _MAX_STR_DIGITS_ERROR_FMT_TO_STR "Exceeds the limit (%d) for integer string conversion"
4041

4142
static PyObject *
4243
get_small_int(sdigit ival)
@@ -1604,6 +1605,23 @@ long_to_decimal_string_internal(PyObject *aa,
16041605
size_a = Py_ABS(Py_SIZE(a));
16051606
negative = Py_SIZE(a) < 0;
16061607

1608+
/* quick and dirty pre-check for overflowing the decimal digit limit,
1609+
based on the inequality 10/3 >= log2(10)
1610+
1611+
explanation in https://github.com/python/cpython/pull/96537
1612+
*/
1613+
if (size_a >= 10 * _PY_LONG_MAX_STR_DIGITS_THRESHOLD
1614+
/ (3 * PyLong_SHIFT) + 2) {
1615+
PyInterpreterState *interp = _PyInterpreterState_GET();
1616+
int max_str_digits = interp->int_max_str_digits;
1617+
if ((max_str_digits > 0) &&
1618+
(max_str_digits / (3 * PyLong_SHIFT) <= (size_a - 11) / 10)) {
1619+
PyErr_Format(PyExc_ValueError, _MAX_STR_DIGITS_ERROR_FMT_TO_STR,
1620+
max_str_digits);
1621+
return -1;
1622+
}
1623+
}
1624+
16071625
/* quick and dirty upper bound for the number of digits
16081626
required to express a in base _PyLong_DECIMAL_BASE:
16091627
@@ -1669,8 +1687,8 @@ long_to_decimal_string_internal(PyObject *aa,
16691687
Py_ssize_t strlen_nosign = strlen - negative;
16701688
if ((max_str_digits > 0) && (strlen_nosign > max_str_digits)) {
16711689
Py_DECREF(scratch);
1672-
PyErr_Format(PyExc_ValueError, _MAX_STR_DIGITS_ERROR_FMT,
1673-
max_str_digits, strlen_nosign);
1690+
PyErr_Format(PyExc_ValueError, _MAX_STR_DIGITS_ERROR_FMT_TO_STR,
1691+
max_str_digits);
16741692
return -1;
16751693
}
16761694
}
@@ -2344,7 +2362,7 @@ digit beyond the first.
23442362
PyInterpreterState *interp = _PyInterpreterState_GET();
23452363
int max_str_digits = interp->int_max_str_digits;
23462364
if ((max_str_digits > 0) && (digits > max_str_digits)) {
2347-
PyErr_Format(PyExc_ValueError, _MAX_STR_DIGITS_ERROR_FMT,
2365+
PyErr_Format(PyExc_ValueError, _MAX_STR_DIGITS_ERROR_FMT_TO_INT,
23482366
max_str_digits, digits);
23492367
return NULL;
23502368
}

0 commit comments

Comments
 (0)