You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomcat.apache.org by Daniel Ruggeri <dr...@primary.net> on 2017/08/21 21:03:03 UTC
Regression with PKCS11 KeyStores?
Hello, Tomcat devs;
I have detected what appears to be a regression in 8.5.20 with JSSE
keystores since 8.5.16. With my limited understanding I'm unable to
pinpoint the exact cause to a certainty after poking around a bit, so I
thought I'd pass what info I have along and get some thoughts.
Below is the error message I am getting:
21-Aug-2017 15:01:57.989 SEVERE [main]
org.apache.catalina.core.StandardService.initInternal Failed to
initialize connector [Connector[Http11Nio2ProtocolCryptovault-25005
]]
org.apache.catalina.LifecycleException: Failed to initialize component
[Connector[Http11Nio2ProtocolCryptovault-25005]]
at
org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:112)
at
org.apache.catalina.core.StandardService.initInternal(StandardService.java:549)
at
org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
at
org.apache.catalina.core.StandardServer.initInternal(StandardServer.java:875)
at
org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
at org.apache.catalina.startup.Catalina.load(Catalina.java:607)
at org.apache.catalina.startup.Catalina.load(Catalina.java:630)
at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
at
sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
at
sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
at java.lang.reflect.Method.invoke(Method.java:498)
at
org.apache.catalina.startup.Bootstrap.load(Bootstrap.java:311)
at
org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:494)
Caused by: org.apache.catalina.LifecycleException: Protocol handler
initialization failed
at
org.apache.catalina.connector.Connector.initInternal(Connector.java:999)
at
org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
... 12 more
Caused by: java.lang.IllegalArgumentException:
java.security.KeyStoreException: Cannot get key bytes, not PKCS#8
encoded
at
org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:114)
at
org.apache.tomcat.util.net.AbstractJsseEndpoint.initialiseSsl(AbstractJsseEndpoint.java:85)
at
org.apache.tomcat.util.net.Nio2Endpoint.bind(Nio2Endpoint.java:163)
at
org.apache.tomcat.util.net.AbstractEndpoint.init(AbstractEndpoint.java:982)
at
org.apache.tomcat.util.net.AbstractJsseEndpoint.init(AbstractJsseEndpoint.java:244)
at
org.apache.coyote.AbstractProtocol.init(AbstractProtocol.java:620)
at
org.apache.coyote.http11.AbstractHttp11Protocol.init(AbstractHttp11Protocol.java:66)
at
org.apache.catalina.connector.Connector.initInternal(Connector.java:997)
... 13 more
Caused by: java.security.KeyStoreException: Cannot get key bytes, not
PKCS#8 encoded
at
sun.security.provider.KeyProtector.protect(KeyProtector.java:174)
at
sun.security.provider.JavaKeyStore.engineSetKeyEntry(JavaKeyStore.java:267)
at
sun.security.provider.JavaKeyStore$JKS.engineSetKeyEntry(JavaKeyStore.java:56)
at
sun.security.provider.KeyStoreDelegator.engineSetKeyEntry(KeyStoreDelegator.java:117)
at
sun.security.provider.JavaKeyStore$DualFormatJKS.engineSetKeyEntry(JavaKeyStore.java:70)
at java.security.KeyStore.setKeyEntry(KeyStore.java:1140)
at
org.apache.tomcat.util.net.jsse.JSSEUtil.getKeyManagers(JSSEUtil.java:226)
at
org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:112)
... 20 mor
I did notice that because of the revision mentioned above (to
JSSEUtil.java), KeyStore objects that aren't PEM encoded are loaded as
an in-memory JKS keystore and a call to setKeyEntry is made. I may be
wrong, but I think this is causing the failure. The hint I had to go
from is that the documentation for the second form of setKeyEntry
requires the key bytes to be PKCS8 encoded since this underlying
keystore is JKS[1]... but we cannot guarantee that the getKey[2] call
returned a Key that is PKCS8 encoded. With the implementation I am
using, it's unclear what the encoding is for the Key object, but since
PKCS11 is a common interface for hardware crypto, I'm sure many
different types (or none at all) are possible. Looking into the source
for engineSetKeyEntry(String alias, byte[] key, Certificate[] chain), I
see that a call to protect() is made which does the check for PKCS8
encoding. This appears to explain the exception.
Unfortunately... I'm not sure where to go from there (if that even is
the issue). It wouldn't help to switch to setKeyEntry(String alias,
byte[] key, Certificate[] chain) since that also has the same PKCS8
encoding requirement. I also don't think it would be possible to obtain
the raw key bytes since a hardware crypto device would certainly block
such an operation and it would be out of Tomcat's place to try to
convert among encoding formats.
Thoughts greatly appreciated
[1]
https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#setKeyEntry(java.lang.String,%20java.security.Key,%20char[],%20java.security.cert.Certificate[]
[2]
https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#getKey(java.lang.String, char[])
--
Daniel Ruggeri
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: Regression with PKCS11 KeyStores?
Posted by Daniel Ruggeri <dr...@primary.net>.
On 2017-08-22 02:24, Mark Thomas wrote:
> On 21/08/17 22:03, Daniel Ruggeri wrote:
>> Hello, Tomcat devs;
>> I have detected what appears to be a regression in 8.5.20 with JSSE
>> keystores since 8.5.16. With my limited understanding I'm unable to
>> pinpoint the exact cause to a certainty after poking around a bit, so
>> I
>> thought I'd pass what info I have along and get some thoughts.
>>
>> Below is the error message I am getting:
>> 21-Aug-2017 15:01:57.989 SEVERE [main]
>> org.apache.catalina.core.StandardService.initInternal Failed to
>> initialize connector [Connector[Http11Nio2ProtocolCryptovault-25005
>> ]]
>> org.apache.catalina.LifecycleException: Failed to initialize
>> component
>> [Connector[Http11Nio2ProtocolCryptovault-25005]]
>> at
>> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:112)
>> at
>> org.apache.catalina.core.StandardService.initInternal(StandardService.java:549)
>>
>> at
>> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
>> at
>> org.apache.catalina.core.StandardServer.initInternal(StandardServer.java:875)
>>
>> at
>> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
>> at
>> org.apache.catalina.startup.Catalina.load(Catalina.java:607)
>> at
>> org.apache.catalina.startup.Catalina.load(Catalina.java:630)
>> at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
>> at
>> sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
>>
>> at
>> sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
>>
>> at java.lang.reflect.Method.invoke(Method.java:498)
>> at
>> org.apache.catalina.startup.Bootstrap.load(Bootstrap.java:311)
>> at
>> org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:494)
>> Caused by: org.apache.catalina.LifecycleException: Protocol handler
>> initialization failed
>> at
>> org.apache.catalina.connector.Connector.initInternal(Connector.java:999)
>> at
>> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
>> ... 12 more
>> Caused by: java.lang.IllegalArgumentException:
>> java.security.KeyStoreException: Cannot get key bytes, not PKCS#8
>> encoded
>> at
>> org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:114)
>>
>> at
>> org.apache.tomcat.util.net.AbstractJsseEndpoint.initialiseSsl(AbstractJsseEndpoint.java:85)
>>
>> at
>> org.apache.tomcat.util.net.Nio2Endpoint.bind(Nio2Endpoint.java:163)
>> at
>> org.apache.tomcat.util.net.AbstractEndpoint.init(AbstractEndpoint.java:982)
>> at
>> org.apache.tomcat.util.net.AbstractJsseEndpoint.init(AbstractJsseEndpoint.java:244)
>>
>> at
>> org.apache.coyote.AbstractProtocol.init(AbstractProtocol.java:620)
>> at
>> org.apache.coyote.http11.AbstractHttp11Protocol.init(AbstractHttp11Protocol.java:66)
>>
>> at
>> org.apache.catalina.connector.Connector.initInternal(Connector.java:997)
>> ... 13 more
>> Caused by: java.security.KeyStoreException: Cannot get key bytes, not
>> PKCS#8 encoded
>> at
>> sun.security.provider.KeyProtector.protect(KeyProtector.java:174)
>> at
>> sun.security.provider.JavaKeyStore.engineSetKeyEntry(JavaKeyStore.java:267)
>> at
>> sun.security.provider.JavaKeyStore$JKS.engineSetKeyEntry(JavaKeyStore.java:56)
>>
>> at
>> sun.security.provider.KeyStoreDelegator.engineSetKeyEntry(KeyStoreDelegator.java:117)
>>
>> at
>> sun.security.provider.JavaKeyStore$DualFormatJKS.engineSetKeyEntry(JavaKeyStore.java:70)
>>
>> at java.security.KeyStore.setKeyEntry(KeyStore.java:1140)
>> at
>> org.apache.tomcat.util.net.jsse.JSSEUtil.getKeyManagers(JSSEUtil.java:226)
>> at
>> org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:112)
>>
>> ... 20 mor
>>
>> I did notice that because of the revision mentioned above (to
>> JSSEUtil.java), KeyStore objects that aren't PEM encoded are loaded as
>> an in-memory JKS keystore and a call to setKeyEntry is made. I may be
>> wrong, but I think this is causing the failure. The hint I had to go
>> from is that the documentation for the second form of setKeyEntry
>> requires the key bytes to be PKCS8 encoded since this underlying
>> keystore is JKS[1]... but we cannot guarantee that the getKey[2] call
>> returned a Key that is PKCS8 encoded. With the implementation I am
>> using, it's unclear what the encoding is for the Key object, but since
>> PKCS11 is a common interface for hardware crypto, I'm sure many
>> different types (or none at all) are possible. Looking into the source
>> for engineSetKeyEntry(String alias, byte[] key, Certificate[] chain),
>> I
>> see that a call to protect() is made which does the check for PKCS8
>> encoding. This appears to explain the exception.
>>
>> Unfortunately... I'm not sure where to go from there (if that even is
>> the issue). It wouldn't help to switch to setKeyEntry(String alias,
>> byte[] key, Certificate[] chain) since that also has the same PKCS8
>> encoding requirement. I also don't think it would be possible to
>> obtain
>> the raw key bytes since a hardware crypto device would certainly block
>> such an operation and it would be out of Tomcat's place to try to
>> convert among encoding formats.
>>
>> Thoughts greatly appreciated
>
> Sounds plausible.
>
> I assume the revision you are referring to is this one:
> https://svn.apache.org/r1800867
You are correct. Someway, somehow, I deleted the commit ID in my
original email... I guess while editing. Sorry about that.
>
> I suppose we could revert it - we are working around a JRE limitation
> after all - but I wonder if there is a better option. My initial
> thoughts are don't use the in memory keystore if the key is PKCS11
> encoded. Can we tell that easily?
That could be a viable approach. I would flip it around just a bit to
be: Only use the in-memory store if the key is PKCS8 encoded. My
thinking is that since various keystore types may or may not have
compatible encoding, it would only be safe to use the in-memory once
we've verified the key encoding.
Something along the (untested) lines of:
KeyStore usedStore = ks;
if (ks == null) {
usedStore = KeyStore.getInstance("JKS");
usedStore.load(null, null);
//Existing stuff to build in-memory store but against
usedStore reference
} else {
if (keyAlias != null && !ks.isKeyEntry(keyAlias)) {
throw new
IOException(sm.getString("jsse.alias_no_key_entry", keyAlias));
}
Key k = ks.getKey(keyAlias, keyPassArray);
if (null == k) {
//Barf
}
if ("PKCS#8".equals(k.getFormat()) {
usedStore = KeyStore.getInstance("JKS");
usedStore.load(null, null);
usedStore.setKeyEntry(keyAlias, k, keyPassArray,
ks.getCertificateChain(keyAlias));
}
//No else... just use the ks as obtained from
certificate.getCertificateKeystore();
}
KeyManagerFactory kmf =
KeyManagerFactory.getInstance(algorithm);
kmf.init(usedStore, keyPassArray);
...
>
> Could you open a Bugzilla issue for this please.
No problem. I delayed doing so to see if I was crazy in my expectations
and/or analysis. Opened the following bug report with the same contents
as the original email I sent:
https://bz.apache.org/bugzilla/show_bug.cgi?id=61451
>
> Thanks,
>
> Mark
>
>
>>
>> [1]
>> https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#setKeyEntry(java.lang.String,%20java.security.Key,%20char[],%20java.security.cert.Certificate[]
>>
>> [2]
>> https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#getKey(java.lang.String,
>> char[])
>>
>> --
>> Daniel Ruggeri
>>
--
Daniel Ruggeri
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org
Re: Regression with PKCS11 KeyStores?
Posted by Mark Thomas <ma...@apache.org>.
On 21/08/17 22:03, Daniel Ruggeri wrote:
> Hello, Tomcat devs;
> I have detected what appears to be a regression in 8.5.20 with JSSE
> keystores since 8.5.16. With my limited understanding I'm unable to
> pinpoint the exact cause to a certainty after poking around a bit, so I
> thought I'd pass what info I have along and get some thoughts.
>
> Below is the error message I am getting:
> 21-Aug-2017 15:01:57.989 SEVERE [main]
> org.apache.catalina.core.StandardService.initInternal Failed to
> initialize connector [Connector[Http11Nio2ProtocolCryptovault-25005
> ]]
> org.apache.catalina.LifecycleException: Failed to initialize component
> [Connector[Http11Nio2ProtocolCryptovault-25005]]
> at
> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:112)
> at
> org.apache.catalina.core.StandardService.initInternal(StandardService.java:549)
>
> at
> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
> at
> org.apache.catalina.core.StandardServer.initInternal(StandardServer.java:875)
>
> at
> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
> at org.apache.catalina.startup.Catalina.load(Catalina.java:607)
> at org.apache.catalina.startup.Catalina.load(Catalina.java:630)
> at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
> at
> sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62)
>
> at
> sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
>
> at java.lang.reflect.Method.invoke(Method.java:498)
> at org.apache.catalina.startup.Bootstrap.load(Bootstrap.java:311)
> at org.apache.catalina.startup.Bootstrap.main(Bootstrap.java:494)
> Caused by: org.apache.catalina.LifecycleException: Protocol handler
> initialization failed
> at
> org.apache.catalina.connector.Connector.initInternal(Connector.java:999)
> at
> org.apache.catalina.util.LifecycleBase.init(LifecycleBase.java:107)
> ... 12 more
> Caused by: java.lang.IllegalArgumentException:
> java.security.KeyStoreException: Cannot get key bytes, not PKCS#8 encoded
> at
> org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:114)
>
> at
> org.apache.tomcat.util.net.AbstractJsseEndpoint.initialiseSsl(AbstractJsseEndpoint.java:85)
>
> at
> org.apache.tomcat.util.net.Nio2Endpoint.bind(Nio2Endpoint.java:163)
> at
> org.apache.tomcat.util.net.AbstractEndpoint.init(AbstractEndpoint.java:982)
> at
> org.apache.tomcat.util.net.AbstractJsseEndpoint.init(AbstractJsseEndpoint.java:244)
>
> at
> org.apache.coyote.AbstractProtocol.init(AbstractProtocol.java:620)
> at
> org.apache.coyote.http11.AbstractHttp11Protocol.init(AbstractHttp11Protocol.java:66)
>
> at
> org.apache.catalina.connector.Connector.initInternal(Connector.java:997)
> ... 13 more
> Caused by: java.security.KeyStoreException: Cannot get key bytes, not
> PKCS#8 encoded
> at
> sun.security.provider.KeyProtector.protect(KeyProtector.java:174)
> at
> sun.security.provider.JavaKeyStore.engineSetKeyEntry(JavaKeyStore.java:267)
> at
> sun.security.provider.JavaKeyStore$JKS.engineSetKeyEntry(JavaKeyStore.java:56)
>
> at
> sun.security.provider.KeyStoreDelegator.engineSetKeyEntry(KeyStoreDelegator.java:117)
>
> at
> sun.security.provider.JavaKeyStore$DualFormatJKS.engineSetKeyEntry(JavaKeyStore.java:70)
>
> at java.security.KeyStore.setKeyEntry(KeyStore.java:1140)
> at
> org.apache.tomcat.util.net.jsse.JSSEUtil.getKeyManagers(JSSEUtil.java:226)
> at
> org.apache.tomcat.util.net.AbstractJsseEndpoint.createSSLContext(AbstractJsseEndpoint.java:112)
>
> ... 20 mor
>
> I did notice that because of the revision mentioned above (to
> JSSEUtil.java), KeyStore objects that aren't PEM encoded are loaded as
> an in-memory JKS keystore and a call to setKeyEntry is made. I may be
> wrong, but I think this is causing the failure. The hint I had to go
> from is that the documentation for the second form of setKeyEntry
> requires the key bytes to be PKCS8 encoded since this underlying
> keystore is JKS[1]... but we cannot guarantee that the getKey[2] call
> returned a Key that is PKCS8 encoded. With the implementation I am
> using, it's unclear what the encoding is for the Key object, but since
> PKCS11 is a common interface for hardware crypto, I'm sure many
> different types (or none at all) are possible. Looking into the source
> for engineSetKeyEntry(String alias, byte[] key, Certificate[] chain), I
> see that a call to protect() is made which does the check for PKCS8
> encoding. This appears to explain the exception.
>
> Unfortunately... I'm not sure where to go from there (if that even is
> the issue). It wouldn't help to switch to setKeyEntry(String alias,
> byte[] key, Certificate[] chain) since that also has the same PKCS8
> encoding requirement. I also don't think it would be possible to obtain
> the raw key bytes since a hardware crypto device would certainly block
> such an operation and it would be out of Tomcat's place to try to
> convert among encoding formats.
>
> Thoughts greatly appreciated
Sounds plausible.
I assume the revision you are referring to is this one:
https://svn.apache.org/r1800867
I suppose we could revert it - we are working around a JRE limitation
after all - but I wonder if there is a better option. My initial
thoughts are don't use the in memory keystore if the key is PKCS11
encoded. Can we tell that easily?
Could you open a Bugzilla issue for this please.
Thanks,
Mark
>
> [1]
> https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#setKeyEntry(java.lang.String,%20java.security.Key,%20char[],%20java.security.cert.Certificate[]
>
> [2]
> https://docs.oracle.com/javase/7/docs/api/java/security/KeyStore.html#getKey(java.lang.String,
> char[])
>
> --
> Daniel Ruggeri
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
> For additional commands, e-mail: dev-help@tomcat.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@tomcat.apache.org
For additional commands, e-mail: dev-help@tomcat.apache.org