From 454a645eed883ccaf4d4cdbddd32db95abd54627 Mon Sep 17 00:00:00 2001
From: Arthur Chan <arthur.chan@adalogics.com>
Date: Fri, 1 Jul 2022 02:34:35 +0100
Subject: [PATCH] python ftfy: initial integration (#7920)

- Create initial integration
- Add fuzzer for fixing function
- Add fuzzer for formatting function
---
 projects/ftfy/Dockerfile     | 22 ++++++++++++++
 projects/ftfy/build.sh       | 24 ++++++++++++++++
 projects/ftfy/fuzz_fix.py    | 56 ++++++++++++++++++++++++++++++++++++
 projects/ftfy/fuzz_format.py | 51 ++++++++++++++++++++++++++++++++
 projects/ftfy/project.yaml   | 12 ++++++++
 5 files changed, 165 insertions(+)
 create mode 100644 projects/ftfy/Dockerfile
 create mode 100644 projects/ftfy/build.sh
 create mode 100644 projects/ftfy/fuzz_fix.py
 create mode 100644 projects/ftfy/fuzz_format.py
 create mode 100644 projects/ftfy/project.yaml

diff --git a/projects/ftfy/Dockerfile b/projects/ftfy/Dockerfile
new file mode 100644
index 000000000..840ec532a
--- /dev/null
+++ b/projects/ftfy/Dockerfile
@@ -0,0 +1,22 @@
+# Copyright 2022 Google LLC
+#
+# Licensed 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.
+#
+################################################################################
+
+FROM gcr.io/oss-fuzz-base/base-builder-python
+
+RUN git clone https://github.com/rspeer/python-ftfy ftfy
+WORKDIR ftfy
+
+COPY build.sh fuzz_*.py $SRC/
diff --git a/projects/ftfy/build.sh b/projects/ftfy/build.sh
new file mode 100644
index 000000000..6da18d63c
--- /dev/null
+++ b/projects/ftfy/build.sh
@@ -0,0 +1,24 @@
+#!/bin/bash -eu
+# Copyright 2022 Google LLC
+#
+# Licensed 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.
+#
+################################################################################
+
+# Build and install project (using current CFLAGS, CXXFLAGS).
+pip3 install --upgrade pip
+pip3 install .
+
+for fuzzer in $(find $SRC -name 'fuzz_*.py'); do
+  compile_python_fuzzer $fuzzer
+done
diff --git a/projects/ftfy/fuzz_fix.py b/projects/ftfy/fuzz_fix.py
new file mode 100644
index 000000000..6476959a7
--- /dev/null
+++ b/projects/ftfy/fuzz_fix.py
@@ -0,0 +1,56 @@
+#!/usr/bin/python3
+# Copyright 2022 Google LLC
+#
+# Licensed 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.
+
+import atheris
+import sys
+with atheris.instrument_imports():
+    import ftfy
+
+def TestInput(data):
+    fdp = atheris.FuzzedDataProvider(data)
+
+    try:
+        ftfy.fix_text(fdp.ConsumeString(1000))
+        ftfy.fix_text(fdp.ConsumeUnicode(1000))
+
+        plan1 = ftfy.fix_and_explain(fdp.ConsumeString(1000))[1]
+        plan2 = ftfy.fix_and_explain(fdp.ConsumeUnicode(1000))[1]
+        ftfy.apply_plan(fdp.ConsumeString(1000), plan1)
+        ftfy.apply_plan(fdp.ConsumeString(1000), plan2)
+        ftfy.apply_plan(fdp.ConsumeUnicode(1000), plan1)
+        ftfy.apply_plan(fdp.ConsumeUnicode(1000), plan2)
+
+        ftfy.fix_text_segment(fdp.ConsumeString(1000))
+        ftfy.fix_text_segment(fdp.ConsumeUnicode(1000))
+
+        f = open("temp.txt", "w")
+        f.write(fdp.ConsumeString(1000))
+        f.write(fdp.ConsumeUnicode(1000))
+        f.close()
+        f = open("temp.txt", "r")
+        ftfy.fix_file(f)
+        f.close()
+
+        ftfy.guess_bytes(fdp.ConsumeBytes(1000))
+    except UnicodeError as e:
+        if "Hey wait, this isn't Unicode." not in str(e):
+            raise e
+
+def main():
+    atheris.Setup(sys.argv, TestInput, enable_python_coverage=True)
+    atheris.Fuzz()
+
+if __name__ == "__main__":
+    main()
diff --git a/projects/ftfy/fuzz_format.py b/projects/ftfy/fuzz_format.py
new file mode 100644
index 000000000..1447cc85c
--- /dev/null
+++ b/projects/ftfy/fuzz_format.py
@@ -0,0 +1,51 @@
+#!/usr/bin/python3
+# Copyright 2022 Google LLC
+#
+# Licensed 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.
+
+import atheris
+import sys
+with atheris.instrument_imports():
+    import ftfy.formatting as ftfy
+    import ftfy.fixes as fixes
+
+def TestInput(data):
+    if len(data) < 1:
+        return
+
+    fdp = atheris.FuzzedDataProvider(data)
+
+    ftfy.character_width(chr(fdp.ConsumeIntInRange(1,1114110)))
+    ftfy.monospaced_width(fdp.ConsumeString(1000))
+    ftfy.monospaced_width(fdp.ConsumeUnicode(1000))
+
+    choice = fdp.ConsumeIntInRange(1,3)
+    if choice == 1:
+        ftfy.display_ljust(fdp.ConsumeString(1000),fdp.ConsumeIntInRange(1,2000))
+        ftfy.display_ljust(fdp.ConsumeUnicode(1000),fdp.ConsumeIntInRange(1,2000))
+    if choice == 2:
+        ftfy.display_rjust(fdp.ConsumeString(1000),fdp.ConsumeIntInRange(1,2000))
+        ftfy.display_rjust(fdp.ConsumeUnicode(1000),fdp.ConsumeIntInRange(1,2000))
+    if choice == 3:
+        ftfy.display_center(fdp.ConsumeString(1000),fdp.ConsumeIntInRange(1,2000))
+        ftfy.display_center(fdp.ConsumeUnicode(1000),fdp.ConsumeIntInRange(1,2000))
+
+    fixes.remove_bom(fdp.ConsumeString(1000))
+    fixes.remove_bom(fdp.ConsumeUnicode(1000))
+    
+def main():
+    atheris.Setup(sys.argv, TestInput, enable_python_coverage=True)
+    atheris.Fuzz()
+
+if __name__ == "__main__":
+    main()
diff --git a/projects/ftfy/project.yaml b/projects/ftfy/project.yaml
new file mode 100644
index 000000000..0f034d3aa
--- /dev/null
+++ b/projects/ftfy/project.yaml
@@ -0,0 +1,12 @@
+fuzzing_engines:
+- libfuzzer
+homepage: https://github.com/rspeer/python-ftfy
+language: python
+main_repo: https://github.com/rspeer/python-ftfy
+sanitizers:
+- address
+- undefined
+vendor_ccs:
+- david@adalogics.com
+- adam@adalogics.com
+- arthur.chan@adalogics.com