Skip to content

Commit 0461d76

Browse files
GovindarajanLGovindarajanL
authored
Merge pull request #8 from GovindarajanL/docs
docs: Add comprehensive framework documentation for contributors and …
2 parents 259814e + e71f89b commit 0461d76

File tree

4 files changed

+473
-1
lines changed

4 files changed

+473
-1
lines changed

‎LICENSE.md‎

Lines changed: 176 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,176 @@
1-
# TODO: Please update this file with the license of your project
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS

‎README.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,14 @@ api-security-testing-framework/
6767

6868
For more detailed information, please refer to our [Documentation](docs/README.md).
6969

70+
## Framework Overview
71+
72+
For detailed understand on the framework, please refer to our [Framework Overview](docs/FRAMEWORK_OVERVIEW.md).
73+
74+
## Architecture
75+
76+
Please refer to our [Architecture](docs/ARCHITECTURE.md).
77+
7078
## Contributing
7179

7280
We welcome contributions from the community! Please see our [Contributing Guidelines](CONTRIBUTING.md) for more information on how to get involved.

‎docs/ARCHITECTURE.md‎

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,183 @@
1+
# Framework Architecture
2+
3+
## Overview
4+
5+
The OWASP API Security Testing Framework is designed with a modular architecture to allow for extensibility and maintainability. This document outlines the high-level architecture and key components of the framework.
6+
7+
## Component Architecture
8+
9+
```
10+
+----------------------------+
11+
| CLI Layer |
12+
+----------------------------+
13+
|
14+
+----------------------------+
15+
| Scanner Core |
16+
+----------------------------+
17+
/ | \
18+
/ | \
19+
+--------+ +--------+ +--------+
20+
| HTTP | | Test | | Report |
21+
| Client | | Cases | | Engine |
22+
+--------+ +--------+ +--------+
23+
```
24+
25+
### Key Components
26+
27+
1. **CLI Layer** (`org.owasp.astf.cli`)
28+
- Parses command-line arguments
29+
- Configures and initializes the scanner
30+
- Handles user interaction
31+
- Manages input/output
32+
33+
2. **Scanner Core** (`org.owasp.astf.core`)
34+
- Orchestrates the scanning process
35+
- Manages test case execution
36+
- Handles multi-threading and concurrency
37+
- Collects and processes results
38+
39+
3. **HTTP Client** (`org.owasp.astf.core.http`)
40+
- Manages API communications
41+
- Handles authentication
42+
- Processes requests and responses
43+
- Supports various HTTP methods and content types
44+
45+
4. **Test Cases** (`org.owasp.astf.testcases`)
46+
- Individual security test implementations
47+
- Each test case targets specific vulnerability types
48+
- Implements the TestCase interface
49+
- Registered and managed by TestCaseRegistry
50+
51+
5. **Report Engine** (`org.owasp.astf.reporting`)
52+
- Generates reports in various formats (JSON, HTML, XML, SARIF)
53+
- Formats findings with appropriate details
54+
- Supports different output destinations
55+
56+
6. **Integrations** (`org.owasp.astf.integrations`)
57+
- CI/CD integration components
58+
- External tool connectors
59+
- Notification systems
60+
61+
## Data Flow
62+
63+
1. User invokes the CLI with scan parameters
64+
2. CLI configures the scanner with appropriate settings
65+
3. Scanner discovers or loads target endpoints
66+
4. For each endpoint, applicable test cases are executed
67+
5. Test cases use the HTTP client to make API requests
68+
6. Findings are collected by the scanner
69+
7. Report engine generates the requested output format
70+
8. Results are returned to the user
71+
72+
## Key Interfaces
73+
74+
### TestCase Interface
75+
76+
```java
77+
public interface TestCase {
78+
String getId();
79+
String getName();
80+
String getDescription();
81+
List<Finding> execute(EndpointInfo endpoint, HttpClient httpClient) throws IOException;
82+
}
83+
```
84+
85+
All test cases implement this interface, allowing the scanner to execute them uniformly.
86+
87+
### EndpointInfo Class
88+
89+
```java
90+
public class EndpointInfo {
91+
private String path;
92+
private String method;
93+
private String contentType;
94+
private String requestBody;
95+
private boolean requiresAuthentication;
96+
97+
// Constructors, getters, etc.
98+
}
99+
```
100+
101+
Represents an API endpoint to be tested, including path, method, and metadata.
102+
103+
### Finding Class
104+
105+
```java
106+
public class Finding {
107+
private String id;
108+
private String title;
109+
private String description;
110+
private Severity severity;
111+
private String testCaseId;
112+
private String endpoint;
113+
private String requestDetails;
114+
private String responseDetails;
115+
private String remediation;
116+
private String evidence;
117+
118+
// Constructors, getters, etc.
119+
}
120+
```
121+
122+
Represents a security finding with all relevant details.
123+
124+
## Design Principles
125+
126+
1. **Modularity**: Components are designed with clear boundaries
127+
2. **Extensibility**: Easy to add new test cases and functionality
128+
3. **Testability**: Components can be tested in isolation
129+
4. **Performance**: Efficient execution for large API surfaces
130+
5. **Usability**: Clear interfaces and documentation
131+
132+
## Thread Model
133+
134+
The scanner uses a thread pool to execute test cases concurrently:
135+
136+
1. One thread per endpoint-testcase combination
137+
2. Configurable thread count via `--threads` option
138+
3. Uses Java 21 virtual threads for efficiency
139+
4. Results are synchronized to prevent race conditions
140+
141+
## Adding New Test Cases
142+
143+
To add a new test case:
144+
145+
1. Create a class implementing the `TestCase` interface
146+
2. Implement the required methods
147+
3. Register the test case in `TestCaseRegistry.registerDefaultTestCases()`
148+
4. Add unit tests for the new test case
149+
150+
Example:
151+
152+
```java
153+
public class NewVulnerabilityTestCase implements TestCase {
154+
@Override
155+
public String getId() {
156+
return "ASTF-API11-2023";
157+
}
158+
159+
@Override
160+
public String getName() {
161+
return "New Vulnerability";
162+
}
163+
164+
@Override
165+
public String getDescription() {
166+
return "Tests for a new type of vulnerability";
167+
}
168+
169+
@Override
170+
public List<Finding> execute(EndpointInfo endpoint, HttpClient httpClient) throws IOException {
171+
// Implement vulnerability detection logic
172+
// Return list of findings (or empty list if none found)
173+
}
174+
}
175+
```
176+
177+
## Future Architecture Enhancements
178+
179+
1. Plugin system for custom test cases
180+
2. Distributed scanning capabilities
181+
3. Real-time reporting and notification
182+
4. Machine learning-based detection improvements
183+
5. Integration with vulnerability management platforms

0 commit comments

Comments
 (0)