Skip to content

Commit 84aed56

Browse files
committed
Modest changes to README.md after PR 853.
1 parent 57c12af commit 84aed56

File tree

1 file changed

+26
-49
lines changed

1 file changed

+26
-49
lines changed

README.md

Lines changed: 26 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ specific Jakarta version of ESAPI, in Maven, you would specify your ESAPI depend
3030
<dependency>
3131
<groupId>org.owasp.esapi</groupId>
3232
<artifactId>esapi</artifactId>
33-
<version>2.5.4.0</version>
33+
<version>2.5.5.0</version> <!-- Preferably the latest version, but > 2.5.3.0 -->
3434
<classifier>jakarta</classifier>
3535
</dependency>
3636
```
@@ -46,40 +46,6 @@ fact, without the
4646
```
4747
that's the version that will be used by default.
4848

49-
# Quickstart - Maven Example
50-
### Step 1: Add the required maven dependencies.
51-
```xml
52-
<dependency>
53-
<groupId>org.owasp.esapi</groupId>
54-
<artifactId>esapi</artifactId>
55-
<version>2.5.3.0 [or later]</version>
56-
<classifier>jakarta</classifier>
57-
</dependency>
58-
<!-- Add the below dependency if the not using JakartaEE -->
59-
<dependency>
60-
<groupId>jakarta.servlet</groupId>
61-
<artifactId>jakarta.servlet-api</artifactId>
62-
<version>6.1.0</version>
63-
<scope>provided</scope>
64-
</dependency>
65-
```
66-
### Step 2: Create 2 properties file namely: ESAPI.properties and validation.properties and add them to your classpath. You can refer to below for boilerplate configurations.
67-
[ESAPI.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/ESAPI.properties) <br/>
68-
[validation.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/validation.properties)
69-
70-
### Step 3: Let's say, you want to remediate log injection vulnerabilities. Below is an example to achieve it.
71-
```code
72-
import org.owasp.esapi.ESAPI;
73-
import org.owasp.esapi.Logger;
74-
75-
public class Example {
76-
private static Logger LOGGER = ESAPI.getLogger(Example.class);
77-
public void printLog(){
78-
LOGGER.info(Logger.EVENT_SUCCESS, "Log injection remediated !");
79-
}
80-
}
81-
```
82-
For more examples, please visit [https://owasp.org/www-project-enterprise-security-api/](https://owasp.org/www-project-enterprise-security-api/).
8349

8450
# A word about ESAPI vulnerabilities
8551
A summary of all the vulnerabilities that we have written about in either the
@@ -118,7 +84,7 @@ The ESAPI release notes may be found in ESAPI's "documentation" directory. They
11884
See the GitHub [Releases](https://github.com/ESAPI/esapi-java-legacy/releases) information for a list of releases which generally
11985
link to the specific release notes.
12086

121-
### Really IMPORTANT information in release notes
87+
### Really IMPORTANT information in release notes - Ignore at your peril
12288
* Starting with ESAPI 2.2.1.0, important details changed reading the ESAPI
12389
Logger. If you have are getting things like ClassNotFoundException, you
12490
probably have not read it. Please be sure to read this specific section
@@ -176,6 +142,30 @@ references in documentation). If you must, you still should be able to
176142
use Log4J 1.x logging via ESAPI SLF4J support. See the ESAPI 2.5.0.0 release
177143
notes for further details.
178144

145+
# Quickstart - Maven Example
146+
### Step 1: Add the required dependencies.
147+
See https://mvnrepository.com/artifact/org.owasp.esapi/esapi/latest, the tab for
148+
whatever build tool you are using. If you need the Jakarta version, make sure to
149+
add
150+
```xml
151+
<classifier>jakarta</classifier>
152+
```
153+
and include whatever jakara.servlet:jakarta.servlet-api version you are using with
154+
```xml
155+
<scope>provided</scope>
156+
```
157+
### Step 2: Obtain the 2 properties files ESAPI.properties and validation.properties
158+
1. Download these 2 files from the ESAPI release that you are using from https://github.com/ESAPI/esapi-java-legacy/releases
159+
and download the esapi-<release>-configuration.jar file (and the .asc file if you wish to confirm the GPG signature).
160+
2. Unjar that configuration file that you just downloaded and find the 2
161+
properties files under the "configuration/esapi" subdirectory where you
162+
unjarred the config jar.
163+
3. Read through Javadoc for [DefaultSecurityConfiguration](https://javadoc.io/static/org.owasp.esapi/esapi/2.5.4.0/org/owasp/esapi/reference/DefaultSecurityConfiguration.html)
164+
to understand the ways that ESAPI locates these files and then use the mechanism that works best for you. Copy the 2 properties
165+
files from the 'configuration/esapi' directory to the directory where you
166+
choose to have them reside. Note that you may also edit them to customize
167+
them according to your needs.
168+
179169
# Contributing to ESAPI legacy
180170
### How can I contribute or help with fix bugs?
181171
Fork and submit a pull request! Easy as pi! (How's that for an irrational
@@ -250,19 +240,6 @@ discussion or even show us how it works with a PR. (Note that we vet all pull
250240
requests, including coding style of any contributions, so please use the same
251241
coding style found in the files you are already editing.)
252242

253-
# Ancient History
254-
### What happened to Google code?
255-
In mid-2014 ESAPI migrated all code and issues from Google Code to GitHub. This migration was completed in November 2014.
256-
257-
### What about the issues still located on Google Code?
258-
All issues from Google Code have been migrated to GitHub issues. We now
259-
use GitHut Issues for reporting everything *except* security vulnerabilities.
260-
Other bug tracking sites are undoubtedly more advanced, but as developers,
261-
we do not want to spent time having to close issues from multiple bug-tracking
262-
systems. Therefore, until the synchronization happens with the Atlassian Jira
263-
instance that we have (but are not using; see GitHub issue #371), please
264-
ONLY use GitHub Issues for reporting bugs.
265-
266243
# References: Where to Find More Information on ESAPI
267244
**OWASP Wiki:** https://owasp.org/www-project-enterprise-security-api/
268245

0 commit comments

Comments
 (0)