Skip to content

Commit

Permalink
Enhance printing OpenSSL versions.
Browse files Browse the repository at this point in the history
* Updated the `OpenSSL::OPENSSL_VERSION_NUMBER` comment explaining the format.
* Added the `OpenSSL::LIBRESSL_VERSION_NUMBER` to print LibreSSL version number,
  in the case that Ruby OpenSSL binding is compiled with LibreSSL. Note
  `test/openssl/utils.rb#libressl?` is not using this value in it for now.
* Update `rake debug` to print the values in a readable way, adding
  `OpenSSL::OPENSSL_VERSION_NUMBER` and `OpenSSL::LIBRESSL_VERSION_NUMBER`.
  • Loading branch information
junaruga committed Aug 15, 2023
1 parent db633c5 commit d19e636
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 2 deletions.
13 changes: 12 additions & 1 deletion Rakefile
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,18 @@ task :debug_compiler do
end

task :debug do
ruby "-I./lib -ropenssl -ve'puts OpenSSL::OPENSSL_VERSION, OpenSSL::OPENSSL_LIBRARY_VERSION'"
ruby_code = <<~'EOF'
openssl_version_number_str = OpenSSL::OPENSSL_VERSION_NUMBER.to_s(16)
libressl_version_number_str = (defined? OpenSSL::LIBRESSL_VERSION_NUMBER) ?
OpenSSL::LIBRESSL_VERSION_NUMBER.to_s(16) : "undefined"
puts <<~MESSAGE
OpenSSL::OPENSSL_VERSION: #{OpenSSL::OPENSSL_VERSION}
OpenSSL::OPENSSL_LIBRARY_VERSION: #{OpenSSL::OPENSSL_LIBRARY_VERSION}
OpenSSL::OPENSSL_VERSION_NUMBER: #{openssl_version_number_str}
OpenSSL::LIBRESSL_VERSION_NUMBER: #{libressl_version_number_str}
MESSAGE
EOF
ruby %Q(-I./lib -ropenssl -ve'#{ruby_code}')
end

task :default => :test
19 changes: 18 additions & 1 deletion ext/openssl/ossl.c
Original file line number Diff line number Diff line change
Expand Up @@ -1149,10 +1149,27 @@ Init_openssl(void)

/*
* Version number of OpenSSL the ruby OpenSSL extension was built with
* (base 16)
* (base 16). The formats are below.
*
* [OpenSSL 3] <tt>0xMNN00PP0 (major minor 00 patch 0)</tt>
* [OpenSSL before 3] <tt>0xMNNFFPPS (major minor fix patch status)</tt>
* [LibreSSL] <tt>0x20000000 (fixed value)</tt>
*
* See also the man page OPENSSL_VERSION_NUMBER(3).
*/
rb_define_const(mOSSL, "OPENSSL_VERSION_NUMBER", INT2NUM(OPENSSL_VERSION_NUMBER));

#if defined(LIBRESSL_VERSION_NUMBER)
/*
* Version number of LibreSSL the ruby OpenSSL extension was built with
* (base 16). The format is <tt>0xMNNFFPPS (major minor fix patch
* status)</tt>. This constant is only defined in LibreSSL cases.
*
* See also the man page OPENSSL_VERSION_NUMBER(3).
*/
rb_define_const(mOSSL, "LIBRESSL_VERSION_NUMBER", INT2NUM(LIBRESSL_VERSION_NUMBER));
#endif

/*
* Boolean indicating whether OpenSSL is FIPS-capable or not
*/
Expand Down

0 comments on commit d19e636

Please sign in to comment.