-
Notifications
You must be signed in to change notification settings - Fork 469
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Issue#711 Appending char to StringBuilder or StringBuffer is not cons…
…idered taint-free. Character types can convey taint because libraries sometimes create String values after converting one String into characters.
- Loading branch information
John Bindel
committed
Aug 18, 2023
1 parent
68628d3
commit 0ca18b5
Showing
3 changed files
with
178 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
108 changes: 108 additions & 0 deletions
108
.../src/test/java/com/h3xstream/findsecbugs/taintanalysis/CharacterTaintPropagationTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,108 @@ | ||
| /** | ||
| * Find Security Bugs | ||
| * Copyright (c) Philippe Arteau, All rights reserved. | ||
| * | ||
| * This library is free software; you can redistribute it and/or | ||
| * modify it under the terms of the GNU Lesser General Public | ||
| * License as published by the Free Software Foundation; either | ||
| * version 3.0 of the License, or (at your option) any later version. | ||
| * | ||
| * This library is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | ||
| * Lesser General Public License for more details. | ||
| * | ||
| * You should have received a copy of the GNU Lesser General Public | ||
| * License along with this library. | ||
| */ | ||
| package com.h3xstream.findsecbugs.taintanalysis; | ||
|
|
||
| import com.h3xstream.findbugs.test.BaseDetectorTest; | ||
| import com.h3xstream.findbugs.test.EasyBugReporter; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| import static org.testng.Assert.assertTrue; | ||
|
|
||
| import static org.mockito.Mockito.*; | ||
|
|
||
| public class CharacterTaintPropagationTest extends BaseDetectorTest { | ||
|
|
||
| @Test | ||
| public void validateCharacterTaintPropagation() throws Exception { | ||
| //Locate test code | ||
| String[] files = { getClassFilePath("testcode/taint/CharacterTaintPropagation") }; | ||
|
|
||
| //Run the analysis | ||
| EasyBugReporter reporter = spy(new SecurityReporter()); | ||
|
|
||
| analyze(files, reporter); | ||
|
|
||
| verify(reporter, times(9)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN").build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharConcat") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromChar") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharToString") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharGetName") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharStringBuilder") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharStringBuffer") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharacterToString") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromCharacterConcat") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, times(1)).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("unsafeFileFromString") | ||
| .withPriority("Medium") | ||
| .build()); | ||
|
|
||
| verify(reporter, never()).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("safeFileFromConstant") | ||
| .build()); | ||
|
|
||
| verify(reporter, never()).doReportBug( | ||
| bugDefinition().bugType("PATH_TRAVERSAL_IN") | ||
| .inClass("CharacterTaintPropagation").inMethod("safeFileFromConstantWithInt") | ||
| .build()); | ||
|
|
||
| } | ||
| } |
62 changes: 62 additions & 0 deletions
62
findsecbugs-samples-java/src/test/java/testcode/taint/CharacterTaintPropagation.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| package testcode.taint; | ||
|
|
||
| import java.io.FileInputStream; | ||
| import java.io.FileNotFoundException; | ||
|
|
||
| public class CharacterTaintPropagation { | ||
|
|
||
| private static final String SAFE_PART = "staticSafePart"; | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharConcat(final char unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream("safePart" + unsafePart); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromChar(final char unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(String.valueOf(unsafePart)); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharToString(final char unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(Character.toString(unsafePart)); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharGetName(final int unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(Character.getName(unsafePart)); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharStringBuilder(final char unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(new StringBuilder("safePart").append(unsafePart).toString()); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharStringBuffer(final char unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(new StringBuffer("safePart").append(unsafePart).toString()); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharacterToString(final Character unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream(unsafePart.toString()); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromCharacterConcat(final Character unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream("safePart" + unsafePart); | ||
| } | ||
|
|
||
| /** This should report PATH_TRAVERSAL_IN. */ | ||
| public FileInputStream unsafeFileFromString(final String unsafePart) throws FileNotFoundException { | ||
| return new FileInputStream("safePart" + unsafePart); | ||
| } | ||
|
|
||
| public FileInputStream safeFileFromConstant() throws FileNotFoundException { | ||
| return new FileInputStream(SAFE_PART); | ||
| } | ||
|
|
||
| public FileInputStream safeFileFromConstantWithInt(final int safeInt) throws FileNotFoundException { | ||
| return new FileInputStream(new StringBuilder(SAFE_PART).append(safeInt).toString()); | ||
| } | ||
| } |