Request to review ESAPI 2.0 crypto - Revision history

Kevin W. Wall: Updates to reflect rc10 now being the latest release candidate.

2010-12-21T08:23:36Z

Updates to reflect rc10 now being the latest release candidate.

Kevin W. Wall: Fix javadoc link.

2010-09-18T00:40:30Z

Fix javadoc link.

Kevin W. Wall: Changes to reflect release of ESAPI 2.0-rc7, which fixed the padded oracle attack.

2010-09-18T00:37:38Z

Changes to reflect release of ESAPI 2.0-rc7, which fixed the padded oracle attack.

Kevin W. Wall: Added reference to Google issue #120.

2010-05-04T05:11:51Z

Added reference to Google issue #120.

Kevin W. Wall: Add link to ESAPI page

2010-04-08T13:22:34Z

Add link to ESAPI page

Kevin W. Wall: Added line counts

2010-04-08T04:10:10Z

Added line counts

Kevin W. Wall: /* Call for Review */

2010-04-08T03:19:37Z

‎Call for Review

Kevin W. Wall at 03:13, 8 April 2010

2010-04-08T03:13:11Z

Kevin W. Wall: /* Call to Review ESAPI Crypto Code */

2010-04-08T03:00:07Z

‎Call to Review ESAPI Crypto Code

Kevin W. Wall at 02:37, 8 April 2010

2010-04-08T02:37:19Z

@@ Line 3: / Line 3: @@
 OWASP is looking for some professional cryptographers and security professionals with expertise in cryptography to donate a small amount of time to review the code and/or documentation handling symmetric encryption in [http://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API Enterprise Security API&nbsp;(ESAPI)] 2.0 before this software package is considered generally available.
-The latest release candidate of OWASP's ESAPI for Java (ESAPI-2.0-rc7) has recently been released. This is the second complete release candidate that contains the completely revamped symmetric encryption and the first release candidate with completed user documentation describing it.
+The latest release candidate of OWASP's ESAPI for Java (ESAPI-2.0_rc10) has recently been released. This is the fifth complete release candidate that contains the completely revamped symmetric encryption and the first release candidate with completed user documentation describing it.
 Many of these changes to ESAPI's symmetric encryption came about as a result of the suggestions of many of you and your fellow cryptographers made on the Metzdowd cryptography mailing list. (See thread "[http://www.mail-archive.com/cryptography@metzdowd.com/msg10889.html Detecting attempts to decrypt with incorrect secret key in OWASP ESAP]I" back in mid-Sept, 2009.) Specifically advice from David A. Wagner and Ian Griggs directly affected several of the detailed design decisions.
@@ Line 13: / Line 13: @@
 Ideally, we would like a few of you with expertise in cryptography to inspect the Java code for correctness and secure implementation. (We remember all too well what happened with the IEEE and WEP when cryptographers were not invited to participate and we would like to avoid any similar issues.)
-The links for the ESAPI-2.0-rc7.zip file as well as separate source code are provided below. As you review things, please keep in mind that ESAPI was meant to be a general API. In particular, this means that not all enterprises have the same security policies so flexibility was required with respect to algorithms allowed, allowed cipher modes, permitted padding schemes, etc. Also allowing compatibility with legacy applications was considered important as well. However, we hope to have chosen reasonable defaults for things such that application developers who do not have issues with compatibility with legacy systems can use the ESAPI crypto configuration as-is without the need for tweaking anything other than the master key and master salt properties (which are left unset by default).
+The links for the ESAPI-2.0_rc10.zip file as well as separate source code are provided below. As you review things, please keep in mind that ESAPI was meant to be a general API. In particular, this means that not all enterprises have the same security policies so flexibility was required with respect to algorithms allowed, allowed cipher modes, permitted padding schemes, etc. Also allowing compatibility with legacy applications was considered important as well. However, we hope to have chosen reasonable defaults for things such that application developers who do not have issues with compatibility with legacy systems can use the ESAPI crypto configuration as-is without the need for tweaking anything other than the master key and master salt properties (which are left unset by default).
 To comment on issues to this source code, email comments to [mailto:kevin.w.wall@gmail.com Kevin Wall] or post an issue on the ESAPI Issues List (see below).<br>
@@ Line 25: / Line 25: @@
 | '''Download ESAPI'''<br>
+|
-[http://owasp-esapi-java.googlecode.com/files/ESAPI-2.0-rc7.zip Download ESAPI-2.0-rc7 zip]
+[http://code.google.com/p/owasp-esapi-java/downloads/detail?name=esapi-2.0_rc10.zip Download ESAPI-2.0_rc10 zip]
 The source code is located is under 'project/src/main/java'. Note that the source code uses Maven 2.0 to build it, via the pom.xml file.<br>
@@ Line 59: / Line 59: @@
 |-
 | '''Javadoc'''<br>
-| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/2.0-rc7/apidocs/index.html ESAPI Javadoc]<br>
+| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/latest/index.html ESAPI Javadoc]<br>
 |-
 | '''General documentation'''<br>
@@ Line 80: / Line 80: @@
 The crypto in ESAPI 2.0-rc6 is known to be vulnerable to a "padded oracle attack"
-which is a type of chosen ciphertext attack designed to reveal plaintext. We believe this is fixed in ESAPI 2.0-rc7 but it would be nice if someone who is a professional cryptographer could confirm this.
+which is a type of chosen ciphertext attack designed to reveal plaintext. We believe this is fixed in ESAPI 2.0_rc10 but it would be nice if someone who is a professional cryptographer could confirm this.
 The details are provided at [http://code.google.com/p/owasp-esapi-java/issues/detail?id=120 ESAPI Google Issues list, issue #120].

@@ Line 59: / Line 59: @@
 |-
 | '''Javadoc'''<br>
-| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/2.0-rc7/index.html ESAPI Javadoc]<br>
+| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/2.0-rc7/apidocs/index.html ESAPI Javadoc]<br>
 |-
 | '''General documentation'''<br>

@@ Line 3: / Line 3: @@
 OWASP is looking for some professional cryptographers and security professionals with expertise in cryptography to donate a small amount of time to review the code and/or documentation handling symmetric encryption in [http://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API Enterprise Security API&nbsp;(ESAPI)] 2.0 before this software package is considered generally available.
-The latest release candidate of OWASP's ESAPI for Java (ESAPI-2.0-rc6) has recently been released. This is the second complete release candidate that contains the completely revamped symmetric encryption and the first release candidate with completed user documentation describing it.
+The latest release candidate of OWASP's ESAPI for Java (ESAPI-2.0-rc7) has recently been released. This is the second complete release candidate that contains the completely revamped symmetric encryption and the first release candidate with completed user documentation describing it.
 Many of these changes to ESAPI's symmetric encryption came about as a result of the suggestions of many of you and your fellow cryptographers made on the Metzdowd cryptography mailing list. (See thread "[http://www.mail-archive.com/cryptography@metzdowd.com/msg10889.html Detecting attempts to decrypt with incorrect secret key in OWASP ESAP]I" back in mid-Sept, 2009.) Specifically advice from David A. Wagner and Ian Griggs directly affected several of the detailed design decisions.
@@ Line 13: / Line 13: @@
 Ideally, we would like a few of you with expertise in cryptography to inspect the Java code for correctness and secure implementation. (We remember all too well what happened with the IEEE and WEP when cryptographers were not invited to participate and we would like to avoid any similar issues.)
-The links for the ESAPI-2.0-rc6.zip file as well as separate source code are provided below. As you review things, please keep in mind that ESAPI was meant to be a general API. In particular, this means that not all enterprises have the same security policies so flexibility was required with respect to algorithms allowed, allowed cipher modes, permitted padding schemes, etc. Also allowing compatibility with legacy applications was considered important as well. However, we hope to have chosen reasonable defaults for things such that application developers who do not have issues with compatibility with legacy systems can use the ESAPI crypto configuration as-is without the need for tweaking anything other than the master key and master salt properties (which are left unset by default).
+The links for the ESAPI-2.0-rc7.zip file as well as separate source code are provided below. As you review things, please keep in mind that ESAPI was meant to be a general API. In particular, this means that not all enterprises have the same security policies so flexibility was required with respect to algorithms allowed, allowed cipher modes, permitted padding schemes, etc. Also allowing compatibility with legacy applications was considered important as well. However, we hope to have chosen reasonable defaults for things such that application developers who do not have issues with compatibility with legacy systems can use the ESAPI crypto configuration as-is without the need for tweaking anything other than the master key and master salt properties (which are left unset by default).
 To comment on issues to this source code, email comments to [mailto:kevin.w.wall@gmail.com Kevin Wall] or post an issue on the ESAPI Issues List (see below).<br>
@@ Line 25: / Line 25: @@
 | '''Download ESAPI'''<br>
+|
-[http://owasp-esapi-java.googlecode.com/files/ESAPI-2.0-rc6.zip Download ESAPI-2.0-rc6 zip]
+[http://owasp-esapi-java.googlecode.com/files/ESAPI-2.0-rc7.zip Download ESAPI-2.0-rc7 zip]
 The source code is located is under 'project/src/main/java'. Note that the source code uses Maven 2.0 to build it, via the pom.xml file.<br>
@@ Line 59: / Line 59: @@
 |-
 | '''Javadoc'''<br>
-| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/2.0-rc6/index.html ESAPI Javadoc]<br>
+| [http://owasp-esapi-java.googlecode.com/svn/trunk_doc/2.0-rc7/index.html ESAPI Javadoc]<br>
 |-
 | '''General documentation'''<br>
@@ Line 80: / Line 80: @@
 The crypto in ESAPI 2.0-rc6 is known to be vulnerable to a "padded oracle attack"
-which is a type of chosen ciphertext attack designed to reveal plaitext.
+which is a type of chosen ciphertext attack designed to reveal plaintext. We believe this is fixed in ESAPI 2.0-rc7 but it would be nice if someone who is a professional cryptographer could confirm this.
 The details are provided at [http://code.google.com/p/owasp-esapi-java/issues/detail?id=120 ESAPI Google Issues list, issue #120].

@@ Line 76: / Line 76: @@
 __NOTOC__
-<br>
+<br><br>
 [[Category:OWASP_Enterprise_Security_API]]

@@ Line 1: / Line 1: @@
 = Call for Review<br>  =
-OWASP is looking for some professional cryptographers and security professionals with expertise in cryptography to donate a small amount of time to review the code and/or documentation handling symmetric encryption in Enterprise Security API&nbsp;(ESAPI) 2.0 before this software package is considered generally available.
+OWASP is looking for some professional cryptographers and security professionals with expertise in cryptography to donate a small amount of time to review the code and/or documentation handling symmetric encryption in [http://www.owasp.org/index.php/Category:OWASP_Enterprise_Security_API Enterprise Security API&nbsp;(ESAPI)] 2.0 before this software package is considered generally available.
 The latest release candidate of OWASP's ESAPI for Java (ESAPI-2.0-rc6) has recently been released. This is the second complete release candidate that contains the completely revamped symmetric encryption and the first release candidate with completed user documentation describing it.

@@ Line 30: / Line 30: @@
 |-
-| '''Code'''<br>
+|
 Relevant configuration properties (ESAPI.properties file): [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/resources/.esapi/ESAPI.properties ESAPI.properties file]
@@ Line 58: / Line 62: @@
 |-
 | '''General documentation'''<br>
 | Describes reasons of [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-readme-crypto-changes.html why we are changing the ESAPI symmetric crypto for ESAPI 2.0]<br>
-Description of the [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-ciphertext-serialization.pdf portable serialization of CipherText objects]<br>
+Description of the [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-ciphertext-serialization.pdf portable serialization of CipherText objects]<br> [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-symmetric-crypto-user-guide.html User Guide for Symmetric Encryption in ESAPI 2.0]<br>
 [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-symmetric-crypto-user-guide.html User Guide for Symmetric Encryption in ESAPI 2.0]<br>
 |-
 | '''ESAPI Issues List'''<br>

@@ Line 32: / Line 32: @@
 | '''Code'''<br>
+|
 Relevant configuration properties (ESAPI.properties file): [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/resources/.esapi/ESAPI.properties ESAPI.properties file]
 ----
 Interface (Encryptor): [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/Encryptor.java Encryptor interface]
 ----
@@ Line 42: / Line 42: @@
 Helper implementation classes (CipherSpec, CipherText, CipherTextSerializer, CryptoHelper, PlainText, SecurityProviderLoader): [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/crypto/ Crypto helper classes]<br>
 *CipherSpec: All relevant data for using Cipher, except the SecretKey
 *CipherText: All the CipherSpec data, plus the ciphertext from encrypting
 *CipherTextSerializer: Helper class to assist with portable serialization of CipherText objects.
 *CryptoHelper: Static helper methods.
 Of these, the method I want to see inspected above all others is<br>''&nbsp;&nbsp;&nbsp;&nbsp; public static SecretKey computeDerivedKey(SecretKey keyDerivationKey, int keySize, String purpose)''<br> Implementation (JavaEncryptor):
 ----
@@ Line 58: / Line 58: @@
 |-
 | '''General documentation'''<br>
-| Describes reasons we are changing the ESAPI symmetric crypto for ESAPI 2.0<br>Description of the portable serialization of CipherText objects<br>User Guide for Symmetric Encryption in ESAPI 2.0<br>
+| Describes reasons of [http://owasp-esapi-java.googlecode.com/svn/trunk/documentation/esapi4java-core-2.0-readme-crypto-changes.html why we are changing the ESAPI symmetric crypto for ESAPI 2.0]<br>
 |-
 | '''ESAPI Issues List'''<br>
-| [http://code.google.com/p/owasp-esapi-java/issues/list Google Issues List]<br> Requires Google account to submit new issues.<br> Note that issue # 81 is a request to review the computeDerivedKey()<br> method in CryptoHelper. You may comment on this issue or add your<br> own if you find defects by first logging in using your Google account.<br>
+| [http://code.google.com/p/owasp-esapi-java/issues/list Google Issues List]<br> Requires Google account to submit new issues.<br> Note that issue # 81 is a request to review the ''computeDerivedKey()'' method in CryptoHelper. You may comment on this issue or add your own if you find defects by first logging in using your Google account.<br>
 |}

@@ Line 17: / Line 17: @@
 To comment on issues to this source code, email comments to [mailto:kevin.w.wall@gmail.com Kevin Wall] or post an issue on the ESAPI Issues List (see below).<br>
-Thanks to those of you have already help provided back in September and any future contribution you are able to make.
+Thanks to those of you have already help provided back in September and any future contribution you are able to make. If you would care to be acknowledged in some future ESAPI documentation for your contribution, please let OWASP know that as well, and if so, whether you only wish your name to be mentioned, or your name and email address.<br>
 ----
@@ Line 34: / Line 32: @@
 | '''Code'''<br>
+|
-Relevant configuration properties (ESAPI.properties file):<br> [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/resources/.esapi/ESAPI.properties ESAPI.properties file]<br> Interface (Encryptor):<br> [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/Encryptor.java Encryptor interface]<br> Helper implementation classes (CipherSpec, CipherText, CipherTextSerializer,<br> CryptoHelper, PlainText, SecurityProviderLoader)<br> [http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/crypto/ Crypto help classes]<br> CipherSpec: All relevant data for using Cipher, except the SecretKey<br> CipherText: All the CipherSpec data, plus the ciphertext from encrypting<br> CipherTextSerializer: Helper class to assist with portable serialization<br> of CipherText objects.<br> CryptoHelper: Static helper methods. Of these, the method I want to see<br> inspected above all others is<br> public static SecretKey computeDerivedKey(<br> SecretKey keyDerivationKey,<br> int keySize,<br> String purpose)<br> Implementation (JavaEncryptor):<br>[http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/reference/crypto/JavaEncryptor.java JavaEncryptor class]<br> Welcome feedback on all methods, but please focus on the *symmetric*<br> encryption / decryption methods (all called encrypt() / decrypt()).
+[http://owasp-esapi-java.googlecode.com/svn/trunk/src/main/java/org/owasp/esapi/reference/crypto/JavaEncryptor.java JavaEncryptor class]<br> We welcome feedback on all methods, but please focus on the *symmetric*<br> encryption / decryption methods (all named encrypt() / decrypt()) in this class.
 |-