Bug 1836275

Summary: SunPKCS11 provider does not support wrapping PKI keys with secret keys
Product: [Fedora] Fedora Reporter: matti aarnio <matti.aarnio>
Component: java-1.8.0-openjdkAssignee: Martin Balao <mbalao>
Status: CLOSED EOL QA Contact: Fedora Extras Quality Assurance <extras-qa>
Severity: unspecified Docs Contact:
Priority: unspecified    
Version: 35CC: ahughes, dbhole, jerboaa, jvanek, msrb, mvala
Target Milestone: ---   
Target Release: ---   
Hardware: Unspecified   
OS: Unspecified   
Whiteboard:
Fixed In Version: Doc Type: If docs needed, set a value
Doc Text:
Story Points: ---
Clone Of: Environment:
Last Closed: 2022-12-13 15:15:07 UTC Type: Bug
Regression: --- Mount Type: ---
Documentation: --- CRM:
Verified Versions: Category: ---
oVirt Team: --- RHEL 7.3 requirements from Atomic Host:
Cloudforms Team: --- Target Upstream Version:
Embargoed:

Description matti aarnio 2020-05-15 14:26:40 UTC
Description of problem:
 The SunPKCS11 provider supports only wrapping of AES keys with an RSA keypair.
 In order to implement eIDAS server-side signatures we need Cipher.wrap() of
 PKI keys (RSA, ECDSA, etc.) with a HSM stored symmetric key.


Version-Release number of selected component (if applicable):
 java-1.8.0-openjdk-devel-1.8.0.252.b09-0.fc31.x86_64
 java-11-openjdk-devel-11.0.7.10-0.fc31.x86_64


How reproducible:
  Every time.

Steps to Reproduce:
1.  Define a JCE Provider with SunPKCS11 configuration.
2.  Generate a keypair at HSM, try to extract wrapped private key:
    
    PrivateKey privateKey = ... ;
    SecretKey aesKeyRef = ... (load from provider's keystore) ;
    Cipher c = Cipher.getInstance("AES/ECB/PKCS5PADDING", provider);
    c.init(Cipher.MODE_WRAP, aesKeyRef, iv);
    byte[] wrappedPrivateKey = c.wrap(privateKey);

3.  Observe that "wrappedPrivateKey" is null.


Actual results:
   null pointer

Expected results:
   wrapped key data

Additional info:

  Looking at   sun.security.pkcs11.P11Cipher class:

    // see JCE spec
    @Override
    protected byte[] engineWrap(Key key) throws IllegalBlockSizeException,
            InvalidKeyException {
        // XXX key wrapping
        throw new UnsupportedOperationException("engineWrap()");
    }

    // see JCE spec
    @Override
    protected Key engineUnwrap(byte[] wrappedKey, String wrappedKeyAlgorithm,
            int wrappedKeyType)
            throws InvalidKeyException, NoSuchAlgorithmException {
        // XXX key unwrapping
        throw new UnsupportedOperationException("engineUnwrap()");
    }


  Implementation appears to be missing.


The keytool does not support generating secret keys at specified provider.
Generating the HSM resident Key-encrypting-key must be done with pkcs11 tooling as keytool can not be used.  See  [Bug 1833301]

Comment 1 matti aarnio 2020-05-19 15:53:48 UTC
I did an experimental implementation of this by creating a copy of
openjdk-1.8.0-252's SunPKCS11 driver to package name "openjdk.pkcs11".
I uploaded whole tarball on ticket https://bugzilla.redhat.com/show_bug.cgi?id=1837501

It compiles with "ant" and latest OpenJDK-1.8.0-252-devel on Linux.

Due to plentiful addition of "this.", it will be somewhat hard to diff
in between the original and this fork.  Consider this a working prototype,
but your coding style may dictate differences.


The OpenJDK-11 has same issues with key wrapping, and NONEwithRSA Signatures.
Probably even Java-14 has these issues.

OpenJDK-11 PKCS11 has additional RSA-PSS support, which was not back-ported
to OpenJDK-1.8.0 when JCE aspects of RSA-PSS were back-ported on 252.

- - -

I think all code changes are in Java, the C files are just JNI aspect
with changes that package name modification caused.

I did test this implementation with Utimaco CryptoServer HSM in my lab.
Using the SoftHSMv2 may be possible too as PKCS11 module.

Comment 2 Ben Cotton 2020-08-11 13:31:16 UTC
This bug appears to have been reported against 'rawhide' during the Fedora 33 development cycle.
Changing version to 33.

Comment 3 Ben Cotton 2021-11-04 17:38:35 UTC
This message is a reminder that Fedora 33 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora 33 on 2021-11-30.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
Fedora 'version' of '33'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, simply change the 'version' 
to a later Fedora version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora 33 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora, you are encouraged  change the 'version' to a later Fedora 
version prior this bug is closed as described in the policy above.

Although we aim to fix as many bugs as possible during every release's 
lifetime, sometimes those efforts are overtaken by events. Often a 
more recent Fedora release includes newer upstream software that fixes 
bugs or makes them obsolete.

Comment 4 Ben Cotton 2022-11-29 16:48:38 UTC
This message is a reminder that Fedora Linux 35 is nearing its end of life.
Fedora will stop maintaining and issuing updates for Fedora Linux 35 on 2022-12-13.
It is Fedora's policy to close all bug reports from releases that are no longer
maintained. At that time this bug will be closed as EOL if it remains open with a
'version' of '35'.

Package Maintainer: If you wish for this bug to remain open because you
plan to fix it in a currently maintained version, change the 'version' 
to a later Fedora Linux version.

Thank you for reporting this issue and we are sorry that we were not 
able to fix it before Fedora Linux 35 is end of life. If you would still like 
to see this bug fixed and are able to reproduce it against a later version 
of Fedora Linux, you are encouraged to change the 'version' to a later version
prior to this bug being closed.

Comment 5 Ben Cotton 2022-12-13 15:15:07 UTC
Fedora Linux 35 entered end-of-life (EOL) status on 2022-12-13.

Fedora Linux 35 is no longer maintained, which means that it
will not receive any further security or bug fix updates. As a result we
are closing this bug.

If you can reproduce this bug against a currently maintained version of Fedora Linux
please feel free to reopen this bug against that version. Note that the version
field may be hidden. Click the "Show advanced fields" button if you do not see
the version field.

If you are unable to reopen this bug, please file a new report against an
active release.

Thank you for reporting this bug and we are sorry it could not be fixed.