From 1fb3ed5c048d132cabe4fccd6e7a9f67da825a53 Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 31 Aug 2024 15:24:04 +0530 Subject: [PATCH 1/6] Updated README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ac6dda95e..21b9aed04 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,7 @@ specific Jakarta version of ESAPI, in Maven, you would specify your ESAPI depend org.owasp.esapi esapi - 2.5.3.0-SNAPSHOT + 2.5.4.0 jakarta ``` From 882c8a3effcfacfea678873cc124d5ada179a727 Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 31 Aug 2024 15:43:30 +0530 Subject: [PATCH 2/6] Update README.md --- README.md | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) diff --git a/README.md b/README.md index 21b9aed04..c64f65245 100644 --- a/README.md +++ b/README.md @@ -46,6 +46,41 @@ fact, without the ``` that's the version that will be used by default. +# Quickstart - Maven Example +#### Step 1: Add the required maven dependencies +```xml + + org.owasp.esapi + esapi + 2.5.4.0 + jakarta + + + jakarta.servlet + jakarta.servlet-api + 6.1.0 + provided + +``` +#### Step 2: Download the ESAPI.properties and validation.properties from below locations and put it in your classpath. +[ESAPI.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/ESAPI.properties)
+[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. +```code +import org.owasp.esapi.ESAPI; +import org.owasp.esapi.Logger; + +public class Example { + private static Logger LOGGER = ESAPI.getLogger(Example.class); + public void printLog(){ + LOGGER.info(Logger.EVENT_SUCCESS, "Log injection remediated !"); + } +} +``` + + + # 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 From f07bb849c9b1e5e018960b090809fa7c41b03480 Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 31 Aug 2024 15:45:03 +0530 Subject: [PATCH 3/6] Update README.md --- README.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/README.md b/README.md index c64f65245..e9de03d66 100644 --- a/README.md +++ b/README.md @@ -78,9 +78,6 @@ public class Example { } } ``` - - - # 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 From 057ce7208b5a4028a85393fec1090b0d979cc33e Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 31 Aug 2024 15:45:42 +0530 Subject: [PATCH 4/6] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index e9de03d66..89e7d05b4 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ 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 ```xml org.owasp.esapi @@ -62,11 +62,11 @@ that's the version that will be used by default. provided ``` -#### Step 2: Download the ESAPI.properties and validation.properties from below locations and put it in your classpath. +### Step 2: Download the ESAPI.properties and validation.properties from below locations and put it in your classpath. [ESAPI.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/ESAPI.properties)
[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. +### Step 3: Let's say, you want to remediate log injection vulnerabilities. Below is an example to achieve it. ```code import org.owasp.esapi.ESAPI; import org.owasp.esapi.Logger; From 662fdabb34395bcfafd57e0d7021800853ec000d Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 31 Aug 2024 15:46:38 +0530 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 89e7d05b4..86238e158 100644 --- a/README.md +++ b/README.md @@ -47,7 +47,7 @@ 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. ```xml org.owasp.esapi From f76892b21c1aedd57b3f8129c92e845c5502e70f Mon Sep 17 00:00:00 2001 From: Debajit Kumar Phukan <71944582+DebajitKumarPhukan@users.noreply.github.com> Date: Sat, 14 Sep 2024 10:12:46 +0530 Subject: [PATCH 6/6] Updates --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 86238e158..0d3f847cd 100644 --- a/README.md +++ b/README.md @@ -52,9 +52,10 @@ that's the version that will be used by default. org.owasp.esapi esapi - 2.5.4.0 + 2.5.3.0 [or later] jakarta + jakarta.servlet jakarta.servlet-api @@ -62,7 +63,7 @@ that's the version that will be used by default. provided ``` -### Step 2: Download the ESAPI.properties and validation.properties from below locations and put it in your classpath. +### 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. [ESAPI.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/ESAPI.properties)
[validation.properties](https://github.com/ESAPI/esapi-java-legacy/blob/develop/configuration/esapi/validation.properties) @@ -78,6 +79,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/). + # 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