Skip to content

Commit

Permalink
Fix OpenSSL::PKey.read that cannot parse PKey in the FIPS mode.
Browse files Browse the repository at this point in the history
This commit is a workaround to fix this issue below.

The `OpenSSL::PKey.read` fails with the OpenSSL 3.0 FIPS mode enabled.

```
$ openssl genrsa -out key.pem 4096

$ ruby -e "require 'openssl'; OpenSSL::PKey.read(File.read('key.pem'))"
-e:1:in `read': Could not parse PKey (OpenSSL::PKey::PKeyError)
  from -e:1:in `<main>'
```

The root cause is that the `OSSL_DECODER_CTX_set_selection` doesn't set the
selection value in the life time of the `OSSL_DECODER_CTX` variable in the
OpenSSL FIPS mode case.

The workaround is to create `OSSL_DECODER_CTX` variable each time, when using
the `OSSL_DECODER_CTX_set_selection` to set a different selection value.
  • Loading branch information
junaruga committed Apr 13, 2023
1 parent 01361c7 commit ec1f812
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions ext/openssl/ossl_pkey.c
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,9 @@ ossl_pkey_read_generic(BIO *bio, VALUE pass)
goto out;
OSSL_BIO_reset(bio);

/* Then check PEM; multiple OSSL_DECODER_from_bio() calls may be needed */
if (OSSL_DECODER_CTX_set_input_type(dctx, "PEM") != 1)
goto out;
/*
* Then check PEM; multiple OSSL_DECODER_from_bio() calls may be needed.
*
* First check for private key formats. This is to keep compatibility with
* ruby/openssl < 3.0 which decoded the following as a private key.
*
Expand All @@ -124,8 +123,19 @@ ossl_pkey_read_generic(BIO *bio, VALUE pass)
*
* Note that normally, the input is supposed to contain a single decodable
* PEM block only, so this special handling should not create a new problem.
*
* Note that we need to create the OSSL_DECODER_CTX variable each time when
* we use the different selection as a workaround.
* https://github.com/openssl/openssl/issues/20657
*/
OSSL_DECODER_CTX_set_selection(dctx, EVP_PKEY_KEYPAIR);
OSSL_DECODER_CTX_free(dctx);
dctx = NULL;
dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, "PEM", NULL, NULL,
EVP_PKEY_KEYPAIR, NULL, NULL);
if (!dctx)
goto out;
if (OSSL_DECODER_CTX_set_pem_password_cb(dctx, ossl_pem_passwd_cb, ppass) != 1)
goto out;
while (1) {
if (OSSL_DECODER_from_bio(dctx, bio) == 1)
goto out;
Expand All @@ -139,7 +149,13 @@ ossl_pkey_read_generic(BIO *bio, VALUE pass)
}

OSSL_BIO_reset(bio);
OSSL_DECODER_CTX_set_selection(dctx, 0);
OSSL_DECODER_CTX_free(dctx);
dctx = NULL;
dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, "PEM", NULL, NULL, 0, NULL, NULL);
if (!dctx)
goto out;
if (OSSL_DECODER_CTX_set_pem_password_cb(dctx, ossl_pem_passwd_cb, ppass) != 1)
goto out;
while (1) {
if (OSSL_DECODER_from_bio(dctx, bio) == 1)
goto out;
Expand Down

0 comments on commit ec1f812

Please sign in to comment.