syntax-symphony 0.0.1__tar.gz

syntax_symphony-0.0.1/LICENSE

@@ -0,0 +1,20 @@
+ 
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

syntax_symphony-0.0.1/PKG-INFO

@@ -0,0 +1,162 @@
+Metadata-Version: 2.1
+Name: syntax_symphony
+Version: 0.0.1
+Summary: Efficient grammar-based fuzzer.
+Author: Stanimir Iglev
+Author-email: Stanimir Iglev <iglev.stanimir@gmail.com>
+Maintainer-email: Stanimir Iglev <iglev.stanimir@gmail.com>
+License:  
+        MIT License
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in all
+        copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+        SOFTWARE.
+Project-URL: Homepage, https://github.com/StanimirIglev/syntax-symphony
+Project-URL: Documentation, https://github.com/StanimirIglev/syntax-symphony/blob/master/README.md
+Project-URL: Repository, https://github.com/StanimirIglev/syntax-symphony
+Project-URL: Changelog, https://github.com/StanimirIglev/syntax-symphony/blob/master/CHANGELOG.md
+Keywords: fuzzer,fuzzing,testing,grammar,grammars
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Topic :: Software Development :: Testing
+Classifier: Intended Audience :: Developers
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: schema>=0.7.7
+
+# Syntax Symphony
+
+## Overview
+
+Syntax Symphony is a powerful fuzzer designed to automatically generate test inputs for various applications based on user-defined grammars.
+The fuzzer leverages the grammar rules to create meaningful and diverse input data, facilitating robust testing of applications.
+In order to achieve high diversity and coverage of grammar rules, it uses k-coverage, as discussed by [Havrikov et al.](https://ieeexplore.ieee.org/abstract/document/8952419). This work has been greatly influenced by the concepts and ideas outlined in the [Fuzzing Book](https://www.fuzzingbook.org/).
+
+With Syntax Symphony, you can enhance the quality and reliability of your software by generating a comprehensive set of test cases effortlessly. Start fuzzing today and make your software more robust against unexpected inputs!
+
+
+## Getting Started
+
+### Prerequisites
+- Python 3.10 or higher
+
+### Installation
+
+#### From PyPI
+```bash
+pip install syntax-symphony
+```
+#### From Source
+1. Clone the repository:
+```bash
+git clone
+cd syntax_symphony
+```
+
+2. We recommend creating a virtual environment to install the dependencies:
+```bash
+python -m venv venv
+source venv/bin/activate
+python -m pip install -r requirements.txt
+```
+
+3. Install locally (add flag -e to install in editable mode):
+```bash
+pip install .
+```
+
+4. To build the package:
+```bash
+python -m pip install build
+python -m build
+```
+This should create the package in the `dist/` directory.
+
+## CLI
+Syntax Symphony provides a command-line interface (CLI) to interact with the fuzzer. The CLI allows you to specify the grammar file, the number of test cases to generate, and the output directory to save the generated test cases among others.
+
+### Example usage:
+```bash
+# Generate 100 test cases using the grammar file examples/expr_grammar.json
+ssfuzz -g examples/expr_grammar.json -c 100
+
+# Save the output in the directory out/
+ssfuzz -g examples/expr_grammar.json -c 100 -d out
+
+# Set the start symbol
+ssfuzz -g examples/expr_grammar.json -c 100 --start begin
+
+# Set the file extension
+ssfuzz -g examples/expr_grammar.json -c 100 -e json
+```
+
+### Full syntax:
+```
+ssfuzz [-h] -g FILE [-s SYMBOL] -c NUMBER [-d DIR] [-e EXT] [--max-depth NUMBER] [--min-depth NUMBER] [-k NUMBER]
+
+Syntax Symphony Fuzzer
+
+options:
+  -h, --help            show this help message and exit
+  -g FILE, --grammar FILE
+                        Path to the grammar file
+  -s SYMBOL, --start SYMBOL
+                        Start symbol of the grammar (without <...>). Default: start
+  -c NUMBER, --count NUMBER
+                        Number of strings to generate
+  -d DIR, --dir DIR     Output directory for the generated strings. Default: output
+  -e EXT, --file-extension EXT
+                        The file extension to be used for the produced documents. Default: txt
+  --max-depth NUMBER    Maximum depth for the derivation trees. Default: 10
+  --min-depth NUMBER    Minimum depth for the derivation trees. Default: 1
+  -k NUMBER, --kcov NUMBER
+                        Number of strings to generate for k-cov. Default: 1
+```
+
+## API
+Syntax Symphony can also be used as a library in your Python projects. The API provides a simple interface to generate test inputs using the fuzzer.
+
+### Example usage:
+```python
+from syntax_symphony.fuzzer import SyntaxSymphony
+from syntax_symphony.grammar import Grammar
+
+# Define the grammar
+grammar = Grammar({
+    "<start>": ["<expr>"],
+    "<expr>": ["<term> + <expr>", "<term> - <expr>", "<term>"],
+    "<term>": ["<factor> * <term>", "<factor> / <term>", "<factor>"],
+    "<factor>": ["<number>", "(<expr>)"],
+    "<number>": ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]
+})
+
+# Create the fuzzer
+fuzzer = SyntaxSymphony(grammar)
+
+# Generate 10 test cases
+for i in range(10):
+    test_case = fuzzer.fuzz()
+    print(test_case)
+```
+
+## Contributing
+We welcome contributions from the community. If you have ideas for improvements, new features, or bug fixes, please submit a pull request or open an issue on our GitHub repository.
+
+## License
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.

syntax_symphony-0.0.1/README.md

@@ -0,0 +1,120 @@
+# Syntax Symphony
+
+## Overview
+
+Syntax Symphony is a powerful fuzzer designed to automatically generate test inputs for various applications based on user-defined grammars.
+The fuzzer leverages the grammar rules to create meaningful and diverse input data, facilitating robust testing of applications.
+In order to achieve high diversity and coverage of grammar rules, it uses k-coverage, as discussed by [Havrikov et al.](https://ieeexplore.ieee.org/abstract/document/8952419). This work has been greatly influenced by the concepts and ideas outlined in the [Fuzzing Book](https://www.fuzzingbook.org/).
+
+With Syntax Symphony, you can enhance the quality and reliability of your software by generating a comprehensive set of test cases effortlessly. Start fuzzing today and make your software more robust against unexpected inputs!
+
+
+## Getting Started
+
+### Prerequisites
+- Python 3.10 or higher
+
+### Installation
+
+#### From PyPI
+```bash
+pip install syntax-symphony
+```
+#### From Source
+1. Clone the repository:
+```bash
+git clone
+cd syntax_symphony
+```
+
+2. We recommend creating a virtual environment to install the dependencies:
+```bash
+python -m venv venv
+source venv/bin/activate
+python -m pip install -r requirements.txt
+```
+
+3. Install locally (add flag -e to install in editable mode):
+```bash
+pip install .
+```
+
+4. To build the package:
+```bash
+python -m pip install build
+python -m build
+```
+This should create the package in the `dist/` directory.
+
+## CLI
+Syntax Symphony provides a command-line interface (CLI) to interact with the fuzzer. The CLI allows you to specify the grammar file, the number of test cases to generate, and the output directory to save the generated test cases among others.
+
+### Example usage:
+```bash
+# Generate 100 test cases using the grammar file examples/expr_grammar.json
+ssfuzz -g examples/expr_grammar.json -c 100
+
+# Save the output in the directory out/
+ssfuzz -g examples/expr_grammar.json -c 100 -d out
+
+# Set the start symbol
+ssfuzz -g examples/expr_grammar.json -c 100 --start begin
+
+# Set the file extension
+ssfuzz -g examples/expr_grammar.json -c 100 -e json
+```
+
+### Full syntax:
+```
+ssfuzz [-h] -g FILE [-s SYMBOL] -c NUMBER [-d DIR] [-e EXT] [--max-depth NUMBER] [--min-depth NUMBER] [-k NUMBER]
+
+Syntax Symphony Fuzzer
+
+options:
+  -h, --help            show this help message and exit
+  -g FILE, --grammar FILE
+                        Path to the grammar file
+  -s SYMBOL, --start SYMBOL
+                        Start symbol of the grammar (without <...>). Default: start
+  -c NUMBER, --count NUMBER
+                        Number of strings to generate
+  -d DIR, --dir DIR     Output directory for the generated strings. Default: output
+  -e EXT, --file-extension EXT
+                        The file extension to be used for the produced documents. Default: txt
+  --max-depth NUMBER    Maximum depth for the derivation trees. Default: 10
+  --min-depth NUMBER    Minimum depth for the derivation trees. Default: 1
+  -k NUMBER, --kcov NUMBER
+                        Number of strings to generate for k-cov. Default: 1
+```
+
+## API
+Syntax Symphony can also be used as a library in your Python projects. The API provides a simple interface to generate test inputs using the fuzzer.
+
+### Example usage:
+```python
+from syntax_symphony.fuzzer import SyntaxSymphony
+from syntax_symphony.grammar import Grammar
+
+# Define the grammar
+grammar = Grammar({
+    "<start>": ["<expr>"],
+    "<expr>": ["<term> + <expr>", "<term> - <expr>", "<term>"],
+    "<term>": ["<factor> * <term>", "<factor> / <term>", "<factor>"],
+    "<factor>": ["<number>", "(<expr>)"],
+    "<number>": ["0", "1", "2", "3", "4", "5", "6", "7", "8", "9"]
+})
+
+# Create the fuzzer
+fuzzer = SyntaxSymphony(grammar)
+
+# Generate 10 test cases
+for i in range(10):
+    test_case = fuzzer.fuzz()
+    print(test_case)
+```
+
+## Contributing
+We welcome contributions from the community. If you have ideas for improvements, new features, or bug fixes, please submit a pull request or open an issue on our GitHub repository.
+
+## License
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.

syntax_symphony-0.0.1/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["setuptools >= 61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "syntax_symphony"
+version = "0.0.1"
+description = "Efficient grammar-based fuzzer."
+readme = "README.md"
+requires-python = ">=3.10"
+authors = [
+    { name = "Stanimir Iglev" },
+    { name = "Stanimir Iglev", email = "iglev.stanimir@gmail.com" },
+]
+maintainers = [{ name = "Stanimir Iglev", email = "iglev.stanimir@gmail.com" }]
+license = { file = "LICENSE" }
+keywords = ["fuzzer", "fuzzing", "testing", "grammar", "grammars"]
+classifiers = [
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Development Status :: 2 - Pre-Alpha",
+    "Topic :: Software Development :: Testing",
+    "Intended Audience :: Developers",
+]
+dependencies = ["schema >= 0.7.7"]
+
+
+[project.urls]
+Homepage = "https://github.com/StanimirIglev/syntax-symphony"
+Documentation = "https://github.com/StanimirIglev/syntax-symphony/blob/master/README.md"
+Repository = "https://github.com/StanimirIglev/syntax-symphony"
+Changelog = "https://github.com/StanimirIglev/syntax-symphony/blob/master/CHANGELOG.md"
+
+[project.scripts]
+ssfuzz = "syntax_symphony.cli:ssfuzz"
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+testpaths = ["tests"]

syntax_symphony-0.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

syntax_symphony-0.0.1/setup.py

@@ -0,0 +1,3 @@
+from setuptools import setup
+
+setup(name="syntax_symphony", version="0.0.1")

syntax_symphony-0.0.1/src/syntax_symphony/__init__.py

@@ -0,0 +1 @@
+ 

syntax_symphony-0.0.1/src/syntax_symphony/cli.py

@@ -0,0 +1,110 @@
+import argparse
+import hashlib
+import os
+from .fuzzer import SyntaxSymphony
+from .grammar import Grammar
+
+
+def ssfuzz():
+    parser = argparse.ArgumentParser(description="Syntax Symphony Fuzzer")
+    parser.add_argument(
+        "-g",
+        "--grammar",
+        dest="grammar",
+        metavar="FILE",
+        required=True,
+        help="Path to the grammar file",
+    )
+    parser.add_argument(
+        "-s",
+        "--start",
+        dest="start_symbol",
+        default="start",
+        metavar="SYMBOL",
+        required=False,
+        type=str,
+        help="Start symbol of the grammar (without <...>). Default: start",
+    )
+    parser.add_argument(
+        "-c",
+        "--count",
+        dest="count",
+        metavar="NUMBER",
+        required=True,
+        type=int,
+        help="Number of strings to generate",
+    )
+    parser.add_argument(
+        "-d",
+        "--dir",
+        dest="output_dir",
+        metavar="DIR",
+        default="out",
+        required=False,
+        type=str,
+        help="Output directory for the generated strings. Default: out",
+    )
+    parser.add_argument(
+        "-e",
+        "--file-extension",
+        dest="file_extension",
+        metavar="EXT",
+        default="txt",
+        help="The file extension to be used for the produced documents. Default: txt",
+    )
+    parser.add_argument(
+        "--max-depth",
+        dest="max_depth",
+        default=10,
+        metavar="NUMBER",
+        required=False,
+        type=int,
+        help="Maximum depth for the derivation trees. Default: 10",
+    )
+    parser.add_argument(
+        "--min-depth",
+        dest="min_depth",
+        default=1,
+        metavar="NUMBER",
+        required=False,
+        type=int,
+        help="Minimum depth for the derivation trees. Default: 1",
+    )
+    parser.add_argument(
+        "-k",
+        "--kcov",
+        dest="kcov",
+        metavar="NUMBER",
+        default=1,
+        required=False,
+        type=int,
+        help="Number of strings to generate for k-cov. Default: 1",
+    )
+
+    args = parser.parse_args()
+
+    with open(args.grammar, "r") as file:
+        grammar_dict = eval(file.read())
+
+    grammar = Grammar(grammar_dict, f"<{args.start_symbol}>")
+
+    fuzzer = SyntaxSymphony(grammar, args.kcov, args.min_depth, args.max_depth)
+
+    if not os.path.isdir(args.output_dir):
+        os.makedirs(args.output_dir)
+
+    for _ in range(args.count):
+        string = fuzzer.fuzz()
+        file_path = (
+            f"{args.output_dir}/"
+            + hashlib.sha256(
+                string.encode(), usedforsecurity=False
+            ).hexdigest()
+            + f".{args.file_extension}"
+        )
+        with open(file_path, "w") as file:
+            file.write(string)
+
+
+if __name__ == "__main__":
+    ssfuzz()