-
Notifications
You must be signed in to change notification settings - Fork 1.1k
fix(jdbc): prevent BigDecimal DoS in StringUtils.consistentToString #17508
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| @@ -0,0 +1,74 @@ | ||||||||||
| /* | ||||||||||
| * Licensed to the Apache Software Foundation (ASF) under one | ||||||||||
| * or more contributor license agreements. See the NOTICE file | ||||||||||
| * distributed with this work for additional information | ||||||||||
| * regarding copyright ownership. The ASF licenses this file | ||||||||||
| * to you under the Apache License, Version 2.0 (the | ||||||||||
| * "License"); you may not use this file except in compliance | ||||||||||
| * with the License. You may obtain a copy of the License at | ||||||||||
| * | ||||||||||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||||||||||
| * | ||||||||||
| * Unless required by applicable law or agreed to in writing, | ||||||||||
| * software distributed under the License is distributed on an | ||||||||||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||||||||||
| * KIND, either express or implied. See the License for the | ||||||||||
| * specific language governing permissions and limitations | ||||||||||
| * under the License. | ||||||||||
| */ | ||||||||||
|
|
||||||||||
| package org.apache.iotdb.jdbc; | ||||||||||
|
|
||||||||||
| import org.junit.Test; | ||||||||||
|
|
||||||||||
| import java.math.BigDecimal; | ||||||||||
|
|
||||||||||
| import static org.junit.Assert.assertEquals; | ||||||||||
| import static org.junit.Assert.assertNull; | ||||||||||
| import static org.junit.Assert.assertTrue; | ||||||||||
|
|
||||||||||
| public class StringUtilsTest { | ||||||||||
|
|
||||||||||
| @Test | ||||||||||
| public void consistentToStringHandlesNull() { | ||||||||||
| assertNull(StringUtils.consistentToString(null)); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| @Test | ||||||||||
| public void consistentToStringExpandsNormalDecimal() { | ||||||||||
| assertEquals("123.45", StringUtils.consistentToString(new BigDecimal("123.45"))); | ||||||||||
| // Plain-string form, not scientific notation. | ||||||||||
| assertEquals("100", StringUtils.consistentToString(new BigDecimal("1E+2"))); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| @Test | ||||||||||
| public void consistentToStringExpandsUpToLimit() { | ||||||||||
| // scale right at the boundary must still be expanded to plain form. | ||||||||||
| BigDecimal atLimit = new BigDecimal("1E+" + StringUtils.MAX_PLAIN_STRING_SCALE); | ||||||||||
| String out = StringUtils.consistentToString(atLimit); | ||||||||||
| assertEquals(StringUtils.MAX_PLAIN_STRING_SCALE + 1, out.length()); | ||||||||||
| assertTrue(out.startsWith("1")); | ||||||||||
| } | ||||||||||
|
|
||||||||||
| /** | ||||||||||
| * Regression test for the BigDecimal DoS: {@code new BigDecimal("1e1000000000")} used to cause | ||||||||||
| * {@link BigDecimal#toPlainString()} to allocate a ~1GB string and OOM the JVM. The guard must | ||||||||||
| * refuse to expand such values and return the compact scientific form instead. | ||||||||||
|
Comment on lines
+55
to
+56
|
||||||||||
| * {@link BigDecimal#toPlainString()} to allocate a ~1GB string and OOM the JVM. The guard must | |
| * refuse to expand such values and return the compact scientific form instead. | |
| * {@link BigDecimal#toPlainString()} to allocate a ~1e9-character string and OOM the JVM. The | |
| * guard must refuse to expand such values and return the compact scientific form instead. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The Javadoc describes
1e1000000000as materializing a "~1GB" String, but the impact depends on JVM/string representation (e.g., on JDK 8 a 1e9-characterStringis closer to ~2GB just for the char array). Consider rewording to an implementation-independent description like "~1e9 characters" / "multi-GB" to keep the documentation accurate across supported Java versions.