8264849: Add KW and KWP support to PKCS11 provider #5569

valeriepeng · 2021-09-17T23:22:21Z

Anyone has time to review this RFE for adding AES cipher with KW, KWP modes support to SunPKCS11 provider?

The main changes are in only one new class, i.e. P11KeyWrapCipher.java, which is the CipherSpi impl for the native PKCS11 key wrap mechanisms. When testing against NSS library, it seems that they only support the single part enc/dec PKCS11 APIs, so have to use a new class as existing P11Cipher class relies on the multi part enc/dec PKCS11 APIs and do not support key wrapping/unwrapping.

The rest are minor code refactoring and updates for the PKCS11 Exception class.
The new regression tests are adapted from existing key wrap regression tests for SunJCE provider.

Thanks,
Valerie

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed

Issue

JDK-8264849: Add KW and KWP support to PKCS11 provider

Reviewers

Anthony Scarpino (@ascarpino - Reviewer)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5569/head:pull/5569
$ git checkout pull/5569

Update a local copy of the PR:
$ git checkout pull/5569
$ git pull https://git.openjdk.java.net/jdk pull/5569/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5569

View PR using the GUI difftool:
$ git pr show -t 5569

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5569.diff

valeriepeng · 2021-09-17T23:22:53Z

/csr

bridgekeeper · 2021-09-17T23:23:03Z

👋 Welcome back valeriep! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2021-09-17T23:25:47Z

@valeriepeng has indicated that a compatibility and specification (CSR) request is needed for this pull request.
@valeriepeng please create a CSR request for issue JDK-8264849. This pull request cannot be integrated until the CSR request is approved.

openjdk · 2021-09-17T23:27:24Z

@valeriepeng The following label will be automatically applied to this pull request:

security

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

mlbridge · 2021-09-17T23:31:41Z

Webrevs

01: Full - Incremental (a79c2fd0)
00: Full (4268589e)

valeriepeng · 2021-09-28T21:23:50Z

Please also review CSR at: https://bugs.openjdk.java.net/browse/JDK-8274174
Thanks.

ascarpino · 2021-09-30T18:41:37Z

From a high level, why does P11KeyWrapCipher support ENCRYPT and DECRYPT modes? I expected to only see UNWRAP and WRAP mode supported. Along those same lines I expected to only see C_WrapKey and C_UnwrapKey, and not encryption/decryption pkcs11 calls. Is there some additional support here that I'm not seeing?

valeriepeng · 2021-09-30T19:54:58Z

The corresponding PKCS11 mechanisms impl in NSS supports enc/dec/wrap/unwrap. In NIST spec 800-38F, these two modes, i.e. KW and KWP, are approved for both key wrapping as well as the protection of general data. Thus, they are implemented to support both enc/dec and wrap/unwrap.

From a high level, why does P11KeyWrapCipher support ENCRYPT and DECRYPT modes? I expected to only see UNWRAP and WRAP mode supported. Along those same lines I expected to only see C_WrapKey and C_UnwrapKey, and not encryption/decryption pkcs11 calls. Is there some additional support here that I'm not seeing?

ascarpino · 2021-09-29T22:40:10Z

src/jdk.crypto.cryptoki/share/classes/sun/security/pkcs11/P11AEADCipher.java

-                errorCode == CKR_GENERAL_ERROR) {
+        } else if (e.match(CKR_ENCRYPTED_DATA_INVALID) ||
+                e.match(CKR_GENERAL_ERROR)) {
+            // CKR_GENERAL_ERROR is Solaris-specific workaround


With Solaris no longer support, this could be removed. Are you leaving it for backporting?

Yes, thought that it may be useful in case this got backported.

ascarpino · 2021-09-29T23:05:38Z

src/jdk.crypto.cryptoki/share/classes/sun/security/pkcs11/P11KeyWrapCipher.java

+ * For multi-part encryption/decryption, this class has to buffer data until
+ * doFinal() is called.
+ *
+ * @since   18


Is there only suppose to be one space between @since and 18?

Sure, will fix.

ascarpino · 2021-09-29T23:56:07Z

test/jdk/sun/security/pkcs11/Cipher/KeyWrap/TestCipherKeyWrapperTest.java

+// adapted from
+// com/sun/crypto/provider/Cipher/KeyWrap/TestCipherKeyWrapperTest.java
+public class TestCipherKeyWrapperTest extends PKCS11Test {
+    private static final int LINIMITED_KEYSIZE = 128;


Did you mean this to be LIMITED_KEYSIZE?

Not sure, the tests are adapted from the existing tests under com/sun/crypto/provider/Cipher/KeyWrap/ and I only do minimum edits to make them test against SunPKCS11 provider.

ascarpino · 2021-09-30T02:32:33Z

src/jdk.crypto.cryptoki/share/classes/sun/security/pkcs11/P11KeyWrapCipher.java

+
+        if (algoParts[0].startsWith("AES")) {
+            // need 3 parts
+            if (algoParts.length != 3) {


At this point in the code, isn't it already certain to be a valid transform? The SunPKCS11 entries are limited to the valid transforms. Additionally do you really want AssertionError? Not NoSuchAlgorithmException?

Hmm, you are right, no need to check again as there are code in javax.crypto.Cipher class which handles this. I will remove it.

ascarpino · 2021-09-30T19:14:10Z

src/jdk.crypto.cryptoki/share/classes/sun/security/pkcs11/P11KeyWrapCipher.java

+    // see JCE spec
+    protected byte[] engineDoFinal(byte[] in, int inOfs, int inLen)
+            throws IllegalBlockSizeException, BadPaddingException {
+        int minOutLen = doFinalLength(inLen);


nit: seems like this could be maxOutLen given it's the length used to allocate out[]. It can't be any larger, otherwise the operations would fail

Sure, I will rename it to maxOutLen

ascarpino · 2021-09-30T23:05:44Z

test/jdk/sun/security/pkcs11/Cipher/KeyWrap/TestGeneral.java

+                    throw new RuntimeException("Failed enc output len check");
+                }
+
+                //System.out.println("enc out.length=" + out.length);


Lelftover debug line?

Yes, will remove.

ascarpino · 2021-10-01T00:51:27Z

test/jdk/sun/security/pkcs11/Cipher/KeyWrap/TestGeneral.java

+ * @summary Verify general properties of the AES/KW/NoPadding,
+ *     AES/KW/PKCS5Padding, and AES/KWP/NoPadding impls of SunPKCS11 provider.
+ * @library /test/lib ../..
+ * @run main/othervm TestGeneral


General question about all the tests. They use othervm, did they not work with agentvm?

Hmm, good question. There are system provider manipulation code in PKCS11Test class, i.e. Security.addProvider(), Security.removeProvider() calls as well as setting/getting system properties. I suppose if we can be sure that things are back to a clean state after each test, then should be ok to use agentvm instead of othervm.

ascarpino

The changes look good

valeriepeng · 2021-10-12T19:03:30Z

The changes look good

Thanks much for review! Could you please also review the CSR as well https://bugs.openjdk.java.net/browse/JDK-8274174?

ascarpino · 2021-10-13T17:36:24Z

I have marked the CSR as reviewed

valeriepeng · 2021-10-13T22:44:41Z

I have marked the CSR as reviewed

Thanks!

openjdk · 2021-10-15T20:49:33Z

@valeriepeng This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8264849: Add KW and KWP support to PKCS11 provider

Reviewed-by: ascarpino

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 358 new commits pushed to the master branch:

831802d: 8275163: Deflater::deflate methods omit javadoc for ReadOnlyBufferException
ad9e234: 8275145: file.encoding system property has an incorrect value on Windows
f178185: 8275249: Suppress warnings on non-serializable array component types in jdk.jlink
ee64ce9: 8274937: Revert the timeout setting for DynamicLoaderConstraintsTest
8c4da9c: 8275013: Improve discussion of serialization method declarations in java.io.Object{Input, Output}Stream
da8da3a: 8269698: Specification for methods of java.awt.im.InputContext should mention that they do nothing
8e02064: 8049520: FileCredentialsCache loads cache once and is never refreshed
172aed1: 8274338: com/sun/jdi/RedefineCrossEvent.java failed "assert(m != __null) failed: NULL mirror"
ced7909: 8275286: Check current thread when calling JRT methods that expect it
c0f3e1d: 8271071: accessibility of a table on macOS lacks cell navigation
... and 348 more: https://git.openjdk.java.net/jdk/compare/7e92abe7a4bd2840fed19826fbff0285732f1765...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

valeriepeng · 2021-10-19T20:17:57Z

/integrate

openjdk · 2021-10-19T20:51:55Z

Going to push as commit e63c148.
Since your change was applied there have been 417 commits pushed to the master branch:

bd2b41d: 8275252: Migrate cacerts from JKS to password-less PKCS12
54a29a4: 8192931: Regression test java/awt/font/TextLayout/CombiningPerf.java fails
4b9303b: 8273308: PatternMatchTest.java fails on CI
25c8584: 8271723: Unproblemlist runtime/InvocationTests/invokevirtualTests.java
76373ae: 8270404: Better canonicalization
24b588e: 8270398: Enhance canonicalization
b774d31: 8266689: More Constrained Delegation
333b9d5: 8265580: Enhanced style for RTF kit
4e4a3cf: 8269763: The JEditorPane is blank after JDK-8265167
af82404: 8269624: Enhance method selection support
... and 407 more: https://git.openjdk.java.net/jdk/compare/7e92abe7a4bd2840fed19826fbff0285732f1765...master

Your commit was automatically rebased without conflicts.

openjdk · 2021-10-19T20:52:35Z

@valeriepeng Pushed as commit e63c148.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

8264849: Add KW and KWP support to PKCS11 provider

4268589

openjdk bot added rfr Pull request is ready for review csr Pull request needs approved CSR before integration labels Sep 17, 2021

openjdk bot added the security security-dev@openjdk.org label Sep 17, 2021

ascarpino reviewed Sep 30, 2021

View reviewed changes

ascarpino reviewed Oct 1, 2021

View reviewed changes

Minor update for review comments.

a79c2fd

ascarpino approved these changes Oct 12, 2021

View reviewed changes

openjdk bot removed the csr Pull request needs approved CSR before integration label Oct 15, 2021

openjdk bot added the ready Pull request is ready to be integrated label Oct 15, 2021

openjdk bot closed this Oct 19, 2021

openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Oct 19, 2021

valeriepeng deleted the JDK-8264849 branch October 19, 2021 21:08

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

8264849: Add KW and KWP support to PKCS11 provider #5569

8264849: Add KW and KWP support to PKCS11 provider #5569

valeriepeng commented Sep 17, 2021 •

edited by openjdk bot

Loading

valeriepeng commented Sep 17, 2021

bridgekeeper bot commented Sep 17, 2021

openjdk bot commented Sep 17, 2021

openjdk bot commented Sep 17, 2021

mlbridge bot commented Sep 17, 2021 •

edited

Loading

valeriepeng commented Sep 28, 2021

ascarpino commented Sep 30, 2021

valeriepeng commented Sep 30, 2021

ascarpino Sep 29, 2021

valeriepeng Oct 1, 2021

ascarpino Sep 29, 2021

valeriepeng Oct 1, 2021

ascarpino Sep 29, 2021

valeriepeng Oct 1, 2021

ascarpino Sep 30, 2021

valeriepeng Oct 1, 2021

ascarpino Sep 30, 2021

valeriepeng Oct 1, 2021

ascarpino Sep 30, 2021

valeriepeng Oct 1, 2021

ascarpino Oct 1, 2021

valeriepeng Oct 1, 2021

ascarpino left a comment

valeriepeng commented Oct 12, 2021

ascarpino commented Oct 13, 2021

valeriepeng commented Oct 13, 2021

openjdk bot commented Oct 15, 2021

valeriepeng commented Oct 19, 2021

openjdk bot commented Oct 19, 2021

openjdk bot commented Oct 19, 2021

8264849: Add KW and KWP support to PKCS11 provider #5569

8264849: Add KW and KWP support to PKCS11 provider #5569

Conversation

valeriepeng commented Sep 17, 2021 • edited by openjdk bot Loading

Progress

Issue

Reviewers

Reviewing

valeriepeng commented Sep 17, 2021

bridgekeeper bot commented Sep 17, 2021

openjdk bot commented Sep 17, 2021

openjdk bot commented Sep 17, 2021

mlbridge bot commented Sep 17, 2021 • edited Loading

Webrevs

valeriepeng commented Sep 28, 2021

ascarpino commented Sep 30, 2021

valeriepeng commented Sep 30, 2021

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ascarpino left a comment

Choose a reason for hiding this comment

valeriepeng commented Oct 12, 2021

ascarpino commented Oct 13, 2021

valeriepeng commented Oct 13, 2021

openjdk bot commented Oct 15, 2021

valeriepeng commented Oct 19, 2021

openjdk bot commented Oct 19, 2021

openjdk bot commented Oct 19, 2021

valeriepeng commented Sep 17, 2021 •

edited by openjdk bot

Loading

mlbridge bot commented Sep 17, 2021 •

edited

Loading