Skip to content

Commit e18046b

Browse files
committed
Complete release notes.
1 parent 7e323cd commit e18046b

File tree

1 file changed

+64
-27
lines changed

1 file changed

+64
-27
lines changed

documentation/esapi4java-core-2.5.3.0-release-notes.txt

Lines changed: 64 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,5 @@
1-
@@@@ IMPORTANT: Be sure to 1) save in DOS text format, and 2) Delete this line and others starting with @@@@
2-
@@@@ Edit this file in vim with :set tw=0
3-
@@@@ Meant to be used with scripts/newReleaseNotes.sh and the 'vars.*' scripts there.
4-
@@@@ There are specific references to ESAPI 2.5.0.0 and other old releases in this file. Do NOT change the version #s. They are there for a reason.
51
Release notes for ESAPI 2.5.3.0
6-
Release date: 2023-11-22
2+
Release date: 2023-11-24
73
Project leaders:
84
-Kevin W. Wall <[email protected]>
95
-Matt Seil <[email protected]>
@@ -13,17 +9,13 @@ Previous release: ESAPI 2.5.2.0, 2023-04-12
139

1410
Executive Summary: Important Things to Note for this Release
1511
------------------------------------------------------------
16-
@@@@ View previous release notes to see examples of what to put here. This is typical. YMMV.
17-
@@@@ Obviously, you should summarize any major changes / new features here.
18-
This is a patch release with the primary intent of updating some dependencies, some with known vulnerabilities. Details follow.
19-
@@@@ Provide a sentence or to
20-
* This is a patch release, with the primary intent of updating ESAPI's AntiSamy dependency from 1.7.3 to 1.7.4. AntiSamy 1.7.4 was released to address an XSS vulnerability in AntiSamy (CVE-2023-43643). Testing ESAPI's use of AntiSamy along with ESAPI's default antsamy-esapi.xml AntiSamy policy file, shows there is no exploitable path of this CVE via ESAPI. This is because ESAPI's AntiSamy policy file is ultra-strict. (Of course, YMMV if you are not using the default AntiSamy policy file or are customized it to disable the 'preserveComments' directive.)
12+
This is a patch release with the primary intent of providing a Jakarta compatible version of ESAPI (see ESAPI Discussion https://github.com/ESAPI/esapi-java-legacy/discussions/768) as well as updating some dependencies, some with known vulnerabilities. Details follow.
13+
* We updated ESAPI's AntiSamy dependency from 1.7.3 to 1.7.4. AntiSamy 1.7.4 was released to address an XSS vulnerability in AntiSamy (CVE-2023-43643). Testing ESAPI's use of AntiSamy along with ESAPI's default antsamy-esapi.xml AntiSamy policy file, indicated there was no exploitable path of this CVE via ESAPI. This is because ESAPI's AntiSamy policy file is ultra-strict. (Of course, YMMV if you are not using the default AntiSamy policy file or are customized it to disable the 'preserveComments' directive.)
2114
* We have deprecated both of ESAPI's Validator.isValidSafeHTML interfaces, as we discovered that they cannot be guaranteed safe. Note that we intend to REMOVE both of these interfaces one year after the ESAPI 2.5.3.0 release. For more details, see GitHub Security Advisory https://github.com/ESAPI/esapi-java-legacy/security/advisories/GHSA-r68h-jhhj-9jvm. There is also an accompanying "ESAPI Security Bulletin 12" (https://github.com/ESAPI/esapi-java-legacy/blob/develop/documentation/ESAPI-security-bulletin12.pdf). The Security Bulletin explains why we did not submit this as a CVE as well as explains some potential workarounds that may work for you.
2215
* Changed ESAPI so that the default RSA modulus length (sometimes referred to as the key size) from 1024-bits to 2048-bits. Note that if you are using an old version of ESAPI.properties file prior to 2.5.3.0 and are using any of the Encryptor interfaces that directly or indirectly use digital signatures (i.e., sign, verifySignature, seal, unseal, verifySeal), you may wish to consider updating properties:
2316
Encryptor.DigitalSignatureAlgorithm=SHA256withDSA # The old SHA1withDSA doesn't support 2048-bit RSA modulus length
2417
Encryptor.DigitalSignatureKeyLength=2048
2518
Note that if you have persisted previous digital signatures that you must continue to verify, you will have to regenerate them.
26-
@@@@ NOTE: This might be reserved for a 2.6.0.0 release, in which case the next line should be removed.
2719
* Thanks to a PR by @jcputney (PR #799), I have attempted to upload additional artifacts to Maven Central that will be a transformed jar suitable for use with the new 'jakarata.servlet' changes for Jakarata EE 9 and later. (Previously, 'javax.servlet' was the name space). Because we are still supporting JDK 8 at this point, we still need to support the 'javax.servlet' namespace as well. In addition to the standard jar artifacts, there should be a new esapi-<release>-jakarta.jar (which uses 'jakarta.servlet' instead of 'javax.servlet' namespace) as well as corresponding *-javadoc.jar and *-sources.jar files. I am not sure it will work as we have no tests for it, but looing at the binaries, it seems like it should.
2820
For additional details, see:
2921
https://github.com/ESAPI/esapi-java-legacy/pull/799
@@ -65,8 +57,6 @@ ESAPI 2.5.3.0 release:
6557

6658
Issue # GitHub Issue Title
6759
----------------------------------------------------------------------------------------------
68-
@@@@ Capture issue #s and 1 line desription from above GitHub url
69-
@@@@ Insert here and massage until it looks pretty. Recommend alignment with spaces instead of tabs.
7060
560 Could not initialize class org.owasp.esapi.logging.java.JavaLogFactory (ESAPI 2.2.1.0)
7161
760 Could not initialize class org. Owasp. Esapi. Reference. DefaultValidator
7262
775 Add documenttion to CONTRIBUTING-TO-ESAPI.txt to mention signed commits are now required.
@@ -82,7 +72,8 @@ Issue # GitHub Issue Title
8272
Changes Requiring Special Attention
8373

8474
-----------------------------------------------------------------------------
85-
@@@@ NOTE any special notes here. Probably leave this one, but I would suggest noting additions BEFORE this.
75+
Deprecated methods to be removed 1 year after the 2.5.3.0 release
76+
* As of the ESAPI 2.5.3.0 release, both Validator.isValidSafeHTML have been deprecated and will be removed one year after the 2.5.3.0 release date.
8677

8778
Important JDK Support Announcement
8879
* 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.
@@ -118,17 +109,13 @@ The effect of upgrade to AntiSamy 1.7.4 in ESAPI 2.5.3.0 can result in ESAPI's V
118109

119110
-----------------------------------------------------------------------------
120111

121-
Developer Activity Report (Changes between release 2.5.2.0 and 2.5.3.0, i.e., between 2023-04-12 and 2023-11-22)
112+
Developer Activity Report (Changes between release 2.5.2.0 and 2.5.3.0, i.e., between 2023-04-12 and 2023-11-24)
122113
Generated manually (this time) -- all errors are the fault of kwwall and his inability to do simple arithmetic.
123114

124-
@@@@
125-
@@@@ This section needs to be manually updated.
126-
@@@@ See file:///home/wallk/work/esapi-work/kww-2.5.3.0-prep/target/site/dev-activity.html for assistance.
127-
@@@@
128115
Developer Total Total Number # Merged
129116
(GitHub ID) commits of Files Changed PRs
130117
========================================================
131-
kwwall 36 37 2
118+
kwwall 40 37 2
132119
noloader 6 12 3
133120
preetgami 1 1 1
134121
robstoll 2 2 1
@@ -156,15 +143,65 @@ CHANGELOG: Create your own. May I suggest:
156143
Direct and Transitive Runtime and Test Dependencies:
157144

158145
$ mvn -B dependency:tree
159-
@@@@ Include output from 'mvn -B dependency:tree' here
160-
@@@@ TODO _after_ running:
161-
@@@@ mvn -U versions:display-plugin-updates
162-
@@@@ mvn -U versions:display-dependency-updates
163-
@@@@ mvn -U versions:display-property-updates
164-
146+
...
147+
[INFO] --- maven-dependency-plugin:3.6.1:tree (default-cli) @ esapi ---
148+
[INFO] org.owasp.esapi:esapi:jar:2.5.3.0
149+
[INFO] +- javax.servlet:javax.servlet-api:jar:3.1.0:provided
150+
[INFO] +- javax.servlet.jsp:javax.servlet.jsp-api:jar:2.3.3:provided
151+
[INFO] +- xom:xom:jar:1.3.9:compile
152+
[INFO] +- commons-beanutils:commons-beanutils:jar:1.9.4:compile
153+
[INFO] | +- commons-logging:commons-logging:jar:1.2:compile
154+
[INFO] | \- commons-collections:commons-collections:jar:3.2.2:compile
155+
[INFO] +- commons-configuration:commons-configuration:jar:1.10:compile
156+
[INFO] +- commons-lang:commons-lang:jar:2.6:compile
157+
[INFO] +- commons-fileupload:commons-fileupload:jar:1.5:compile
158+
[INFO] +- org.apache.commons:commons-collections4:jar:4.4:compile
159+
[INFO] +- org.apache-extras.beanshell:bsh:jar:2.0b6:compile
160+
[INFO] +- org.owasp.antisamy:antisamy:jar:1.7.4:compile
161+
[INFO] | +- org.htmlunit:neko-htmlunit:jar:3.6.0:compile
162+
[INFO] | +- org.apache.httpcomponents.client5:httpclient5:jar:5.2.1:compile
163+
[INFO] | | \- org.apache.httpcomponents.core5:httpcore5-h2:jar:5.2:compile
164+
[INFO] | +- org.apache.httpcomponents.core5:httpcore5:jar:5.2.3:compile
165+
[INFO] | +- org.apache.xmlgraphics:batik-css:jar:1.17:compile
166+
[INFO] | | +- org.apache.xmlgraphics:batik-shared-resources:jar:1.17:compile
167+
[INFO] | | +- org.apache.xmlgraphics:batik-util:jar:1.17:compile
168+
[INFO] | | | +- org.apache.xmlgraphics:batik-constants:jar:1.17:compile
169+
[INFO] | | | \- org.apache.xmlgraphics:batik-i18n:jar:1.17:compile
170+
[INFO] | | \- org.apache.xmlgraphics:xmlgraphics-commons:jar:2.9:compile
171+
[INFO] | +- xerces:xercesImpl:jar:2.12.2:compile
172+
[INFO] | \- xml-apis:xml-apis-ext:jar:1.3.04:compile
173+
[INFO] +- org.slf4j:slf4j-api:jar:2.0.6:compile
174+
[INFO] +- xml-apis:xml-apis:jar:1.4.01:compile
175+
[INFO] +- commons-io:commons-io:jar:2.14.0:compile
176+
[INFO] +- com.github.spotbugs:spotbugs-annotations:jar:4.8.1:compile
177+
[INFO] | \- com.google.code.findbugs:jsr305:jar:3.0.2:compile
178+
[INFO] +- commons-codec:commons-codec:jar:1.15:test
179+
[INFO] +- junit:junit:jar:4.13.2:test
180+
[INFO] +- org.bouncycastle:bcprov-jdk15on:jar:1.70:test
181+
[INFO] +- org.hamcrest:hamcrest-core:jar:2.2:test
182+
[INFO] | \- org.hamcrest:hamcrest:jar:2.2:test
183+
[INFO] +- org.powermock:powermock-api-mockito2:jar:2.0.9:test
184+
[INFO] | \- org.powermock:powermock-api-support:jar:2.0.9:test
185+
[INFO] +- org.mockito:mockito-core:jar:3.12.4:test
186+
[INFO] | +- net.bytebuddy:byte-buddy:jar:1.11.13:test
187+
[INFO] | +- net.bytebuddy:byte-buddy-agent:jar:1.11.13:test
188+
[INFO] | \- org.objenesis:objenesis:jar:3.2:test
189+
[INFO] +- org.powermock:powermock-core:jar:2.0.9:test
190+
[INFO] | \- org.javassist:javassist:jar:3.27.0-GA:test
191+
[INFO] +- org.powermock:powermock-module-junit4:jar:2.0.9:test
192+
[INFO] | \- org.powermock:powermock-module-junit4-common:jar:2.0.9:test
193+
[INFO] +- org.powermock:powermock-reflect:jar:2.0.9:test
194+
[INFO] \- org.openjdk.jmh:jmh-core:jar:1.37:test
195+
[INFO] +- net.sf.jopt-simple:jopt-simple:jar:5.0.4:test
196+
[INFO] \- org.apache.commons:commons-math3:jar:3.6.1:test
197+
[INFO] ------------------------------------------------------------------------
198+
[INFO] BUILD SUCCESS
199+
[INFO] ------------------------------------------------------------------------
200+
[INFO] Total time: 1.701 s
201+
[INFO] Finished at: 2023-11-24T13:01:00-05:00
202+
[INFO] ------------------------------------------------------------------------
165203
-----------------------------------------------------------------------------
166204

167-
@@@@ Review these notes, especially the reference to the AntiSamy version information.
168205
Acknowledgments:
169206
Thanks to @noloader, @preetgami, and @jcputney for submitting PRs to help move ESAPI forward. And thanks to Matt Seil, Jeremiah Stacey, and all the ESAPI users who make this worthwhile. This is for you.
170207

0 commit comments

Comments
 (0)