Bug #10115: Error in OpenSSL documentation section: Loading a key

• Status: Closed
• Assignee: -
• Target version: -
• ruby -v: v2.2.0

[reggieb (Rob Nichols)]

The entry in the OpenSSL docs for Loading a key has an error in it I believe.

http://ruby-doc.org/stdlib-2.1.2/libdoc/openssl/rdoc/OpenSSL.html#module-OpenSSL-label-Loading+a+Key

This is the entry:

Loading a Key¶ ↑

A key can also be loaded from a file.

> key2 = OpenSSL::PKey::RSA.new File.read 'private_key.pem'
> key2.public? # => true

or

> key3 = OpenSSL::PKey::RSA.new File.read 'public_key.pem'
> key3.private? # => false

I think it should key2.private? that is true, rather than key2.public? be:

Loading a Key¶ ↑

A key can also be loaded from a file.

> key2 = OpenSSL::PKey::RSA.new File.read 'private_key.pem'
> key2.private? # => true

or

> key3 = OpenSSL::PKey::RSA.new File.read 'public_key.pem'
> key3.private? # => false

[reggieb (Rob Nichols)]

I think the same error is also in the docs for previous version of the Ruby

[zzak (zzak _)]

• ruby -v set to v2.2.0
• Target version deleted (Ruby 2.1.0)
• Tracker changed from Feature to Bug
• Project changed from 14 to Ruby master
• Category set to ext/openssl
• Status changed from Open to Assigned

moving to ruby tracker

[zzak (zzak _)]

• Assignee set to 7150

[rhenium (Kazuki Yamaguchi)]

• Status changed from Assigned to Closed

Strictly speaking, it is not incorrect - PKey::RSA#public? always returns true. But indeed it is very unfriendly. Thanks for reporting!

https://github.com/ruby/openssl/pull/57