Skip to content

Commit 1a37a65

Browse files
xeno6696xeno6696
authored
Merge pull request ESAPI#818 from kwwall/2.5.3.1-prep
2.5.3.1 preparation
2 parents 4b51c48 + 0ebbe72 commit 1a37a65

File tree

9 files changed

+291
-20
lines changed

9 files changed

+291
-20
lines changed

‎documentation/ESAPI-release-steps.odt

-7.39 KB
Binary file not shown.

‎documentation/ESAPI-release-steps.pdf

-6.31 KB
Binary file not shown.

‎documentation/esapi4java-core-2.5.3.1-release-notes.txt

Lines changed: 184 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,184 @@
1+
Release notes for ESAPI 2.5.3.1
2+
Release date: 2023-12-01
3+
Project leaders:
4+
-Kevin W. Wall <[email protected]>
5+
-Matt Seil <[email protected]>
6+
7+
Previous release: ESAPI 2.5.3.0, 2023-11-24
8+
9+
10+
Executive Summary: Important Things to Note for this Release
11+
------------------------------------------------------------
12+
* Rewrite the Javadoc for Validator.isValidSafeHTML to make the dangers more evident.\
13+
* Changes to the DefaultValidator.isValidSafeHTM method so that a warning is always logs one time about the method being deprecated and a reference to the relevant GitHub Security Advisory.
14+
15+
Notes if you are not updating from the immediate previous release. release 2.5.3.0:
16+
* You need to read through the series of release notes FIRST, going in order.
17+
* For example, if you were updating from an older ESAPI release (say, 2.3.0.0), you should go back and FIRST read all the subsequent release notes in turn. For instance, if you are currently on release 2.3.0.0 and upgrading to (say) release 2.x.y.z, you should MINIMALLY read the sections "Changes Requiring Special Attention" in each of the subsequent release notes. So, going from release 2.3.0.0 to 2.x.y.z, you should in turn, read:
18+
19+
esapi4java-core-2.4.0.0-release-notes.txt
20+
esapi4java-core-2.5.0.0-release-notes.txt
21+
esapi4java-core-2.5.1.0-release-notes.txt
22+
esapi4java-core-2.5.2.0-release-notes.txt
23+
...etc., up through the current set of release notes...
24+
esapi4java-core-2.x.y.z-release-notes.txt
25+
26+
in that order. YOU HAVE BEEN WARNED!!! (These release notes are too large to put all this in a given document; very few read them thoroughly as it is.)
27+
28+
If your SCA tool is reporting any CVE from a direct or transitive dependency in ESAPI, before reporting it as an GitHub issue, please make sure that you review the vulnerability analysis written up in https://github.com/ESAPI/esapi-java-legacy/blob/develop/Vulnerability-Summary.md. Please email us or contact us in our GitHub Discussions page if you have questions about this. See also the SECURITY.md file to report any security issues with ESAPI.
29+
30+
You are encouraged to review the vulnerability analysis written up in https://github.com/ESAPI/esapi-java-legacy/blob/develop/Vulnerability-Summary.md and email us or contact us in our GitHub Discussions page if you have questions.
31+
32+
33+
=================================================================================================================
34+
35+
Basic ESAPI facts
36+
-----------------
37+
38+
ESAPI 2.5.3.0 release:
39+
207 Java source files
40+
4293 JUnit tests in 131 Java source files (0 failures, 0 errors, 0 tests skipped)
41+
42+
ESAPI 2.5.3.1 release: (unchanged)
43+
207 Java source files
44+
4293 JUnit tests in 131 Java source files (0 failures, 0 errors, 0 tests skipped)
45+
46+
1 GitHub Issue closed in this release, including those we've decided not to fix (marked 'wontfix' and 'falsepositive').
47+
(Reference: https://github.com/ESAPI/esapi-java-legacy/issues?q=is%3Aissue+state%3Aclosed+updated%3A%3E%3D2023-11-24)
48+
49+
Issue # GitHub Issue Title
50+
----------------------------------------------------------------------------------------------
51+
794 canonicalize sees entity which isn't there (wontfix)
52+
53+
-----------------------------------------------------------------------------
54+
55+
Changes Requiring Special Attention
56+
57+
-----------------------------------------------------------------------------
58+
59+
Important JDK Support Announcement
60+
* ESAPI 2.3.0.0 was the last Java release to support Java 7. ESAPI 2.4.0 requires using Java 8 or later. See the ESAPI 2.4.0.0 release notes (https://github.com/ESAPI/esapi-java-legacy/blob/develop/documentation/esapi4java-core-2.4.0.0-release-notes.txt) for details as to the reason.
61+
- This means if your project requires Java 7, you must use ESAPI 2.3.0.0 or earlier.
62+
63+
Important ESAPI Logging Changes
64+
65+
* Since ESAPI 2.5.0.0, support for logging directly via Log4J 1 has been removed. (This was two years after it haveing first been deprecated.) Thus, you only choice of ESAPI logging are
66+
- java.util.logging (JUL), which as been the default since ESAPI 2.2.1.0.
67+
* Set ESAPI.Logger=org.owasp.esapi.logging.java.JavaLogFactory in your ESAPI.properties file.
68+
- SLF4J (which your choice of supported SLF4J logging implemmentation)
69+
* Set ESAPI.Logger=org.owasp.esapi.logging.slf4j.Slf4JLogFactory in your ESAPI.properties file.
70+
* Logger configuration notes - If you are migrating from prior to ESAPI 2.2.1.1, you will need to update your ESAPI.properties file as logging-related configuration as per the ESAPI 2.2.1.1 release notes, which may be found at:
71+
https://github.com/ESAPI/esapi-java-legacy/blob/develop/documentation/esapi4java-core-2.2.1.1-release-notes.txt#L39-L78
72+
73+
If you use ESAPI 2.5.0.0 or later, you will get an ClassNotFoundException as the root cause if you still have your ESAPI.Logger property set to use Log4J because the org.owasp.esapi.logger.log4j.Log4JFactory class has been completely removed from the ESAPI jar. If you are dead set on continuing to use Log4J 1, you ought to be able to do so via SLF4J. The set up for Log4J 1 (which has not be tested), should be similar to configure ESAPI to use SLF4J with Log4J 2 as described here:
74+
https://github.com/ESAPI/esapi-java-legacy/wiki/Using-ESAPI-with-SLF4J#slf4j-using-log4j-2x
75+
76+
-----------------------------------------------------------------------------
77+
78+
Remaining Known Issues / Problems
79+
80+
-----------------------------------------------------------------------------
81+
None known, other than the remaining open issues on GitHub.
82+
83+
-----------------------------------------------------------------------------
84+
85+
Other changes in this release, some of which not tracked via GitHub issues
86+
87+
-----------------------------------------------------------------------------
88+
89+
* Minor updates to README.md file with respect to version information.
90+
91+
-----------------------------------------------------------------------------
92+
93+
Developer Activity Report (Changes between release 2.5.3.0 and 2.5.3.1, i.e., between 2023-11-24 and 2023-12-01)
94+
Generated manually (this time) -- all errors are the fault of kwwall and his inability to do simple arithmetic.
95+
96+
Developer Total Total Number # Merged
97+
(GitHub ID) commits of Files Changed PRs
98+
========================================================
99+
kwwall 13 16 2
100+
========================================================
101+
Total PRs: 2
102+
103+
-----------------------------------------------------------------------------
104+
105+
CHANGELOG: Create your own. May I suggest:
106+
107+
git log --stat --since=2023-11-24 --reverse --pretty=medium
108+
109+
which will show all the commits since just after the previous (2.5.3.0) release.
110+
111+
Alternately, you can download the most recent ESAPI source and run
112+
113+
mvn site
114+
115+
which will create a CHANGELOG file named 'target/site/changelog.html'
116+
117+
118+
-----------------------------------------------------------------------------
119+
120+
Direct and Transitive Runtime and Test Dependencies:
121+
122+
$ mvn -B dependency:tree
123+
...
124+
[INFO] --- maven-dependency-plugin:3.6.1:tree (default-cli) @ esapi ---
125+
[INFO] org.owasp.esapi:esapi:jar:2.5.3.0
126+
[INFO] +- javax.servlet:javax.servlet-api:jar:3.1.0:provided
127+
[INFO] +- javax.servlet.jsp:javax.servlet.jsp-api:jar:2.3.3:provided
128+
[INFO] +- xom:xom:jar:1.3.9:compile
129+
[INFO] +- commons-beanutils:commons-beanutils:jar:1.9.4:compile
130+
[INFO] | +- commons-logging:commons-logging:jar:1.2:compile
131+
[INFO] | \- commons-collections:commons-collections:jar:3.2.2:compile
132+
[INFO] +- commons-configuration:commons-configuration:jar:1.10:compile
133+
[INFO] +- commons-lang:commons-lang:jar:2.6:compile
134+
[INFO] +- commons-fileupload:commons-fileupload:jar:1.5:compile
135+
[INFO] +- org.apache.commons:commons-collections4:jar:4.4:compile
136+
[INFO] +- org.apache-extras.beanshell:bsh:jar:2.0b6:compile
137+
[INFO] +- org.owasp.antisamy:antisamy:jar:1.7.4:compile
138+
[INFO] | +- org.htmlunit:neko-htmlunit:jar:3.6.0:compile
139+
[INFO] | +- org.apache.httpcomponents.client5:httpclient5:jar:5.2.1:compile
140+
[INFO] | | \- org.apache.httpcomponents.core5:httpcore5-h2:jar:5.2:compile
141+
[INFO] | +- org.apache.httpcomponents.core5:httpcore5:jar:5.2.3:compile
142+
[INFO] | +- org.apache.xmlgraphics:batik-css:jar:1.17:compile
143+
[INFO] | | +- org.apache.xmlgraphics:batik-shared-resources:jar:1.17:compile
144+
[INFO] | | +- org.apache.xmlgraphics:batik-util:jar:1.17:compile
145+
[INFO] | | | +- org.apache.xmlgraphics:batik-constants:jar:1.17:compile
146+
[INFO] | | | \- org.apache.xmlgraphics:batik-i18n:jar:1.17:compile
147+
[INFO] | | \- org.apache.xmlgraphics:xmlgraphics-commons:jar:2.9:compile
148+
[INFO] | +- xerces:xercesImpl:jar:2.12.2:compile
149+
[INFO] | \- xml-apis:xml-apis-ext:jar:1.3.04:compile
150+
[INFO] +- org.slf4j:slf4j-api:jar:2.0.6:compile
151+
[INFO] +- xml-apis:xml-apis:jar:1.4.01:compile
152+
[INFO] +- commons-io:commons-io:jar:2.14.0:compile
153+
[INFO] +- com.github.spotbugs:spotbugs-annotations:jar:4.8.1:compile
154+
[INFO] | \- com.google.code.findbugs:jsr305:jar:3.0.2:compile
155+
[INFO] +- commons-codec:commons-codec:jar:1.15:test
156+
[INFO] +- junit:junit:jar:4.13.2:test
157+
[INFO] +- org.bouncycastle:bcprov-jdk15on:jar:1.70:test
158+
[INFO] +- org.hamcrest:hamcrest-core:jar:2.2:test
159+
[INFO] | \- org.hamcrest:hamcrest:jar:2.2:test
160+
[INFO] +- org.powermock:powermock-api-mockito2:jar:2.0.9:test
161+
[INFO] | \- org.powermock:powermock-api-support:jar:2.0.9:test
162+
[INFO] +- org.mockito:mockito-core:jar:3.12.4:test
163+
[INFO] | +- net.bytebuddy:byte-buddy:jar:1.11.13:test
164+
[INFO] | +- net.bytebuddy:byte-buddy-agent:jar:1.11.13:test
165+
[INFO] | \- org.objenesis:objenesis:jar:3.2:test
166+
[INFO] +- org.powermock:powermock-core:jar:2.0.9:test
167+
[INFO] | \- org.javassist:javassist:jar:3.27.0-GA:test
168+
[INFO] +- org.powermock:powermock-module-junit4:jar:2.0.9:test
169+
[INFO] | \- org.powermock:powermock-module-junit4-common:jar:2.0.9:test
170+
[INFO] +- org.powermock:powermock-reflect:jar:2.0.9:test
171+
[INFO] \- org.openjdk.jmh:jmh-core:jar:1.37:test
172+
[INFO] +- net.sf.jopt-simple:jopt-simple:jar:5.0.4:test
173+
[INFO] \- org.apache.commons:commons-math3:jar:3.6.1:test
174+
...
175+
176+
-----------------------------------------------------------------------------
177+
178+
Acknowledgments:
179+
Another hat tip to Dave Wichers for suggesting logging a warning via the deprecated isValidSafeHTML method.
180+
And, as always, thanks to Matt Seil, Jeremiah Stacey, and all the ESAPI users who make this worthwhile. This is for you.
181+
182+
A special thanks to the ESAPI community from the ESAPI project co-leaders:
183+
Kevin W. Wall (kwwall) <== The irresponsible party for these release notes!
184+
Matt Seil (xeno6696)

‎pom.xml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
<modelVersion>4.0.0</modelVersion>
44
<groupId>org.owasp.esapi</groupId>
55
<artifactId>esapi</artifactId>
6-
<version>2.5.4.0-SNAPSHOT</version>
6+
<version>2.5.3.1-SNAPSHOT</version>
77
<packaging>jar</packaging>
88

99
<distributionManagement>
@@ -141,7 +141,7 @@
141141
<!-- TODO: Be sure to update. Should be date of previous official release -->
142142
<!-- Exact date in the form 'yyyy-dd-yy 00:00:00' should be used. You can find the previous release date -->
143143
<!-- in the previous release notes file under the 'documentation/' directory. -->
144-
<date.prev_release>2023-04-12 00:00:00</date.prev_release>
144+
<date.prev_release>2023-11-24 00:00:00</date.prev_release>
145145
</properties>
146146

147147
<dependencies>

‎scripts/vars.2.5.3.0

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ VERSION=2.5.3.0
88
PREV_VERSION=2.5.2.0
99

1010
# Release date of current version in yyyy-mm-dd format
11-
YYYY_MM_DD_RELEASE_DATE=2023-11-22
11+
YYYY_MM_DD_RELEASE_DATE=2023-11-24
1212

1313
# Previous ESAPI release date in same format
1414
PREV_RELEASE_DATE=2023-04-12

‎scripts/vars.2.5.3.1

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# Do NOT edit this file directly. It will be created by the new createVarsFile.sh script,
2+
# which should be run prior to the newReleaseNotes.sh script.
3+
4+
# ESAPI (new / current) version
5+
VERSION=2.5.3.1
6+
7+
# Previous ESAPI version
8+
PREV_VERSION=2.5.3.0
9+
10+
# Release date of current version in yyyy-mm-dd format
11+
YYYY_MM_DD_RELEASE_DATE=2023-12-01
12+
13+
# Previous ESAPI release date in same format
14+
PREV_RELEASE_DATE=2023-11-24

‎src/main/java/org/owasp/esapi/ValidationRule.java

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,14 @@ public interface ValidationRule {
2020
* the value to be parsed
2121
* @return a validated value
2222
* @throws ValidationException
23-
* if any validation rules fail, <i>except</i> if the
23+
* Thrown if any validation rules fail, <i>except</i> when the
2424
* <b>{@code ESAPI.properties}></b> property
25-
* "Validator.ValidationRule.getValid.ignore509Fix" is set to
26-
* {@code true}, which is the default behavior for ESAPI 2.x
25+
* "Validator.HtmlValidationAction" is set to
26+
* {@code clean}. The default <b>{@code ESAPI.properties}></b> property file
27+
* has "Validator.HtmlValidationAction" is set to {@code throw}, which results
28+
* in a {@code ValidationException} being thrown if any of the validation rules
29+
* fail.
30+
*
2731
* releases. See ESAPI GitHub Issues
2832
* <a href="https://github.com/ESAPI/esapi-java-legacy/issues/509}>509</a>
2933
* and <a href="https://github.com/ESAPI/esapi-java-legacy/issues/521">521</a>

0 commit comments

Comments
 (0)