Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readability Improvement - Wrapped Steps inside Collapsible Details #855

Closed
wants to merge 11 commits into from
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ fact, without the
that's the version that will be used by default.

# Quickstart - Maven Example
### Step 1: Add the required maven dependencies.
#### Step 1: Add the required maven dependencies.
<details>

```xml
<dependency>
<groupId>org.owasp.esapi</groupId>
Expand All @@ -63,11 +65,20 @@ that's the version that will be used by default.
<scope>provided</scope>
</dependency>
```
### 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.

</details>

#### 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.
<details>

[ESAPI.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/ESAPI.properties) <br/>
[validation.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/validation.properties)

### Step 3: Let's say, you want to remediate log injection vulnerabilities. Below is an example to achieve it.
</details>

#### Step 3: Let's say, you want to remediate log injection vulnerabilities. Below is an example to achieve it.
<details>

```code
import org.owasp.esapi.ESAPI;
import org.owasp.esapi.Logger;
Expand All @@ -81,6 +92,8 @@ public class Example {
```
For more examples, please visit [https://owasp.org/www-project-enterprise-security-api/](https://owasp.org/www-project-enterprise-security-api/).

</details>

# A word about ESAPI vulnerabilities
A summary of all the vulnerabilities that we have written about in either the
ESAPI Security Bulletins or in the GitHub Security Advisories may be found
Expand Down
Loading