ruby-core

Issue #10115 has been updated by Zachary Scott.

Assignee set to openssl

----------------------------------------
Bug #10115: Error in OpenSSL documentation section: Loading a key
https://bugs.ruby-lang.org/issues/10115#change-54163

* Author: Rob Nichols
* Status: Assigned
* Priority: Normal
* Assignee: openssl
* ruby -v: v2.2.0
* Backport: 
----------------------------------------
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
~~~



-- 
https://bugs.ruby-lang.org/