You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The ABAP Code Scanner Framework is a powerful tool designed to analyze ABAP (Advanced Business Application Programming) code for potential security vulnerabilities, code quality issues, and best practice violations. This framework provides a flexible and extensible way to scan ABAP code and generate comprehensive reports on various aspects of code security and quality.
6
+
7
+
## Features
8
+
9
+
- Multiple security checks including:
10
+
- Cross-Site Scripting (XSS) vulnerabilities
11
+
- Directory Traversal vulnerabilities
12
+
- Hardcoded credentials
13
+
- Weak cryptographic algorithms
14
+
- And many more...
15
+
- Customizable and extensible architecture
16
+
- Command-line interface for easy integration into CI/CD pipelines
-`-c`, `--config`: Path to the configuration file (default: config.yml)
48
+
49
+
## Configuration
50
+
51
+
The scanner can be configured using a YAML file. By default, it looks for `config.yml` in the project root. You can specify a different configuration file using the `-c` or `--config` option.
52
+
53
+
Example configuration:
54
+
55
+
```yaml
56
+
checks:
57
+
- CheckCrossSiteScripting
58
+
- CheckSQLInjection
59
+
- CheckDirectoryTraversal
60
+
61
+
file_extensions:
62
+
- .abap
63
+
- .txt
64
+
65
+
exclude_patterns:
66
+
- "**/test/**"
67
+
```
68
+
69
+
## Adding New Checks
70
+
71
+
To add a new security check:
72
+
73
+
1. Create a new Python file in the `checks` directory.
74
+
2. Define a class that inherits from a base check class.
75
+
3. Implement the required methods, including the main `run` method.
76
+
4. Add the new check to the configuration file.
77
+
78
+
## Running Tests
79
+
80
+
To run the test suite:
81
+
82
+
On Windows:
83
+
```
84
+
run_tests.bat
85
+
```
86
+
87
+
On Unix-like systems:
88
+
```
89
+
./run_tests.sh
90
+
```
91
+
92
+
## Contributing
93
+
94
+
Contributions to the ABAP Code Scanner Framework are welcome! Please feel free to submit pull requests, create issues or spread the word.
95
+
96
+
## License
97
+
98
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
99
+
100
+
## Acknowledgments
101
+
102
+
- Thanks to all contributors who have helped to improve this framework.
103
+
- Special thanks to the ABAP community for their invaluable resources and documentation.
0 commit comments