Project

General

Profile

Bug #10115

Error in OpenSSL documentation section: Loading a key

Added by Rob Nichols over 2 years ago. Updated 5 months ago.

Status:
Closed
Priority:
Normal
Assignee:
openssl
ruby -v:
v2.2.0
Backport:
[ruby-core:64229]

Description

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

History

#1 [ruby-core:64230] Updated by Rob Nichols over 2 years ago

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

#2 [ruby-core:67349] Updated by Zachary Scott almost 2 years ago

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

moving to ruby tracker

#3 Updated by Zachary Scott about 1 year ago

  • Assignee set to openssl

#4 [ruby-core:76242] Updated by Kazuki Yamaguchi 5 months ago

  • 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

Also available in: Atom PDF