Skip to content

Commit 5ddb839

Browse files
committed
Miscellaneous minor clean-up of release notes.
1) Add release date. 2) Fix multiple spelling errors 3) Document new 'Known Issue' about running 'mvn test' from Windows 10 'cmd' prompt.
1 parent fd009ec commit 5ddb839

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

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

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Release notes for ESAPI 2.2.1.0
2-
Release date: 2020-July-??
2+
Release date: 2020-July-12
33
Project leaders:
44
-Kevin W. Wall <[email protected]>
55
-Matt Seil <[email protected]>
@@ -32,14 +32,14 @@ ESAPI 2.2.1.0 release:
3232
Issue # GitHub Issue Title
3333
----------------------------------------------------------------------------------------------
3434

35-
143 - Enchance encodeForOS to auto-detect the underling OS
35+
143 - Enhance encodeForOS to auto-detect the underling OS
3636
173 - DOMConfigurator is being used inappropriately in the ESAPIWebApplicationFirewallFilter
3737
226 - Javadoc Inaccuracy in getRandomInteger() and getRandomReal()
3838
232 - SecurityWrapperResponse.createCookieHeader modification request (closed; marked 'wontfix')
3939
235 - exception is java.lang.NoClassDefFoundError: org.owasp.esapi.codecs.Codec
4040
245 - KeyDerivationFunction::computeDerivedKey - possible security level mismatch
4141
256 - Whitespace in JavaEncryptor
42-
263 - I am getting validation exception while validating a paramter coming from http request
42+
263 - I am getting validation exception while validating a parameter coming from http request
4343
268 - SecurityWrapperResponse setStatus should not always set SC_OK
4444
269 - org.owasp.esapi.reference.DefaultValidator reports ValidationException with IE 9
4545
271 - Add Constructor to DefaultSecurityConfiguration to accept a properties file (1.4)
@@ -77,7 +77,7 @@ Issue # GitHub Issue Title
7777
Changes Requiring Special Attention
7878

7979
-----------------------------------------------------------------------------
80-
The new default ESAPI logger is JUL (java.util.logging packages) and we have deprecated the use of Log4J 1.x because we now support SLF4J and Log4J 1.x is way past its end-of-life. We did not want to make SLF4J the default logger (at least not yet) as we did not want to have the default ESAPI use require additional dependencies. However, SLF4J is likely to be the future choice, at least once we start on EsAPI 3.0. A special shout-out to Jeremiah Stacey for making this possible by re-factoring much of the ESAPI logger code. Note, the straw that broke the proverbial camel's back was the announcement of CVE-2019-17571 (rated Critical), for which there is no fix available and likely will never be.
80+
The new default ESAPI logger is JUL (java.util.logging packages) and we have deprecated the use of Log4J 1.x because we now support SLF4J and Log4J 1.x is way past its end-of-life. We did not want to make SLF4J the default logger (at least not yet) as we did not want to have the default ESAPI use require additional dependencies. However, SLF4J is likely to be the future choice, at least once we start on ESAPI 3.0. A special shout-out to Jeremiah Stacey for making this possible by re-factoring much of the ESAPI logger code. Note, the straw that broke the proverbial camel's back was the announcement of CVE-2019-17571 (rated Critical), for which there is no fix available and likely will never be.
8181

8282
Related to that CVE and how it affects ESAPI, be sure to read
8383
https://github.com/ESAPI/esapi-java-legacy/blob/develop/documentation/ESAPI-security-bulletin2.pdf
@@ -89,7 +89,7 @@ Notable dependency updates (excludes those only used with JUnit tests):
8989
commons-beansutil 1.9.3 -> 1.9.4
9090
slf4j-api 1.7.26 -> 1.7.30
9191

92-
Finally, while ESAPI still supports JDK 7 (even though that too is way past end-of-life), the next ESAPI release will move to JDK 8 as the minimal baseline. (We already use Java 8 for development but still to Java 7 source and runtime compatiblity.)
92+
Finally, while ESAPI still supports JDK 7 (even though that too is way past end-of-life), the next ESAPI release will move to JDK 8 as the minimal baseline. (We already use Java 8 for development but still to Java 7 source and runtime compatibility.)
9393

9494
-----------------------------------------------------------------------------
9595

@@ -117,6 +117,13 @@ and
117117
I am sure that there are ways of making Bouncy Castle work with Java 7, but since ESAPI does not rely on Bouncy Castle (it can use any compliant JCE provider), this should not be a problem. (It works fine with the default SunJCE provider.) If it is important to get the BC provider working with the ESAPI Encryptor and Java 7, then open a GitHub issue and we will take a deeper look at it and see if we can suggest something.
118118

119119

120+
121+
Another problem is if you run 'mvn test' from the 'cmd' prompt (and possibly PowerShell as well), you will get intermittent failures (generally between 10-25% of the time) at arbitrary spots. If you run it again without any changes it will work fine without any failures. We have discovered that it doesn't seem to fail if you run the tests from an IDE like Eclipse or if you redirect both stdout and stderr to a file; e.g.,
122+
123+
C:\code\esapi-java-legacy> mvn test >testoutput.txt 2>&1
124+
125+
We do not know the reason for these failures, but only that we have observed them on Windows 10. If you see this error, please do NOT report it as a GitHub issue unless you know a fix for it.
126+
120127
-----------------------------------------------------------------------------
121128

122129
Other changes in this release, some of which not tracked via GitHub issues
@@ -167,7 +174,7 @@ PR# GitHub ID Description
167174
508 -- Michael-Ziluck -- Resolves #226 - Corrected docs for the bounded, numeric, random methods
168175
510 -- Michael-Ziluck -- Resolve #509 - Properly throw exception when HTML fails
169176
513 -- kwwall -- Close issue #512 by updating to 1.9.4 of Commons Beans Util.
170-
514 -- xeno6696 -- Fixed issues #503 by writing a new addReferer method, also temporaril
177+
514 -- xeno6696 -- Fixed issues #503 by writing a new addReferer method, also temporarily
171178
516 -- jeremiahjstacey -- Issue 515
172179
518 -- jeremiahjstacey -- Issue #511 Copying Docs from DefaultValidator
173180
519 -- jeremiahjstacey -- Issue 494 CSSCodec RGB Triplets
@@ -260,7 +267,7 @@ Direct and Transitive Runtime and Test Dependencies:
260267

261268
-----------------------------------------------------------------------------
262269

263-
Ackknowledgements:
270+
Acknowledgments:
264271

265272
Release notes written by Bill Sempf ([email protected]), but please direct any communication to the project leaders.
266273

0 commit comments

Comments
 (0)