Skip to content

Commit b2609a5

Browse files
committed
Describe reporting vulnerabilities in README.md
Add paragraph on how to report vulnerabilities (for CII-Best-Practices). Minor changes to other sections.
1 parent aaef54d commit b2609a5

File tree

1 file changed

+19
-10
lines changed

1 file changed

+19
-10
lines changed

README.md

Lines changed: 19 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,47 @@ OWASP ESAPI (The OWASP Enterprise Security API) is a free, open source, web appl
1313
</tr>
1414
</table>
1515

16-
<b>What does Legacy mean?</b><br/>
16+
# What does Legacy mean?
1717
<p>This is the legacy branch of ESAPI which means it is an actively maintained branch of the project, however feature development for this branch will not be done. Features that have already been scheduled for the 2.x branch will move forward, but the main focus will be working on the ESAPI 3.x branch.
1818

1919
<b>IMPORTANT NOTE:</b>
2020
The default branch for ESAPI legacy is now the 'develop' branch (rather than the 'master' branch), where future development, bug fixes, etc. will now be done. The 'master' branch is now marked as "protected"; it reflects the latest stable ESAPI release (2.1.0.1 as of this date). Note that this change of making the 'develop' branch the default may affect any pull requests that you were intending to make.
2121

22-
<b>Where can I find ESAPI 3.x</b><br/>
22+
# Where can I find ESAPI 3.x?
2323
https://github.com/ESAPI/esapi-java
2424

25-
<b>How can I contribute or help with fix bugs?</b><br/>
25+
# Contributing to ESAPI legacy
26+
## How can I contribute or help with fix bugs?
2627
Fork and submit a pull request! Simple as pi! We generally only accept bug fixes, not new features because as a legacy project, we don't intend on adding new features, although we may make exceptions. If you wish to propose a new feature, the best place to discuss it is via the ESAPI-DEV mailing list mentioned below. Note that we vet all pull requests, including coding style of any contributions; use the same coding style found in the files you are already editing.
2728

28-
<b>What happened to Google code?</b><br/>
29+
### What happened to Google code?
2930
In mid-2014 ESAPI Migrated all code to GitHub. This migration was completed in November 2014.
3031

31-
<b>What about the issues still located on Google Code</b><br/>
32+
### What about the issues still located on Google Code?
3233
All issues from Google Code have been migrated to GitHub issues. We have a JIRA/Confluence instance allocated to us, but it has not be configured to synchronize with the GitHub issues, and thus is should not be used. JIRA is fine, but if we can't have it synchronized with GitHub issues (which is where the majority of our users report issues), it is not usuable. As developers, we do not want to spent time having to close issues from multiple bug-tracking sites. Therefore, until this synchronization happens (see GitHub issue #371), please ONLY use GitHub for reporting bugs.
3334

34-
Wiki: https://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API
35+
### Find an Issue?
36+
If you have found a bug, then create an issue on the esapi-legacy-java repo: https://github.com/ESAPI/esapi-java-legacy/issues
3537

36-
Nightly Build: Travis CI - https://travis-ci.org/bkimminich/esapi-java-legacy
38+
### Find a Vulnerability?
39+
If you have found a vulnerability in ESAPI legacy, first search the issues list (see above) to see if it has already been reported. If it has not, then please contact both Kevin W. Wall (kevin.w.wall at gmail.com) and Chris Schmidt (chris.schmidt at owasp.org) directly. Please do not report vulnerabilities via GitHub issues or via the ESAPI mailing lists as we wish to keep our users secure while a patch is implemented and deployed. If you wish to be acknowledged for finding the vulnerability, then please follow this process. (Eventually, we would like to have BugCrowd handle this, but that's still a ways off.) Also, when you post the email describing the vulnerability, please do so from an email address that you usually monitor.
40+
41+
## Where to Find More Information on ESAPI
42+
43+
*Wiki:* https://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API
44+
45+
*Nightly Build:* Travis CI - https://travis-ci.org/bkimminich/esapi-java-legacy
3746

3847
~~JIRA: https://owasp-esapi.atlassian.net/browse/ESAPILEG~~<br />Issues: Until further notice, use the GitHub issues for reporting bugs and enhancement requests.
3948

4049

41-
Documentation: https://owasp-esapi.atlassian.net/wiki/display/ESAPILEG/ESAPI+Legacy (Coming Soon), for now find general documentation under the 'documentation/' directory, and the latest Javadoc under https://www.javadoc.io/doc/org.owasp.esapi/esapi/
50+
*Documentation:* https://owasp-esapi.atlassian.net/wiki/display/ESAPILEG/ESAPI+Legacy (Coming Soon), for now find general documentation under the 'documentation/' directory, and the latest Javadoc under https://www.javadoc.io/doc/org.owasp.esapi/esapi/
4251

43-
Realtime Support available on our IRC Channel:<br/>
52+
*Realtime Support available on our IRC Channel:*<br/>
4453
Server: irc.freenode.net<br/>
4554
Channel: #esapi<br/>
4655
Webchat http://webchat.freenode.net/
4756

48-
Mailing lists:
57+
*Mailing lists:*
4958
[ESAPI-Users mailing list](https://lists.owasp.org/mailman/listinfo/esapi-user/) and
5059
[ESAPI-Developers mailing list](https://lists.owasp.org/mailman/listinfo/esapi-dev/)

0 commit comments

Comments
 (0)