@@ -10,7 +10,7 @@ Bugs and feature requests are tracked on [GitHub].
1010
1111If you think you found a bug, file a ticket on GitHub. Please DO NOT report
1212security issues here, there is a separate procedure which is described on
13- [ "Security at ruby-lang.org"] ( https://www.ruby-lang.org/en/security/ ) .
13+ [ "Security at ruby-lang.org"] [ Ruby Security ] .
1414
1515When reporting a bug, please make sure you include:
1616
@@ -22,26 +22,25 @@ When reporting a bug, please make sure you include:
2222
2323There are a number of unresolved issues and feature requests for openssl that
2424need review. Before submitting a new ticket, it is recommended to check
25- [ known issues] .
25+ [ known issues] [ Issues ] .
2626
2727## Submitting patches
2828
2929Patches are also very welcome!
3030
31- Please submit a [ pull request] with your changes.
31+ Please submit a [ pull request] [ Compare changes ] with your changes.
3232
3333Make sure that your branch does:
3434
3535* Have good commit messages
36- * Follow Ruby's coding style ([ DeveloperHowTo ] )
36+ * Follow Ruby's coding style ([ Developer-How-To ] [ Ruby Developer-How-To ] )
3737* Pass the test suite successfully (see "Testing")
3838
3939## Testing
4040
4141We have a test suite!
4242
43- Test cases are located under the
44- [ ` test/openssl ` ] ( https://github.com/ruby/openssl/tree/master/test/openssl )
43+ Test cases are located under the [ ` test/openssl ` ] [ GitHub test/openssl ]
4544directory.
4645
4746You can run it with the following three commands:
@@ -58,9 +57,9 @@ Ruby OpenSSL supports various versions of the OpenSSL library. The test suite
5857needs to pass on all supported combinations.
5958
6059If you want to test, debug, report an issue, or contribute to the Ruby OpenSSL
61- or [ the OpenSSL project] ( https://www.openssl.org/ ) in the non-FIPS or
62- the [ FIPS] ( https://github.com/openssl/openssl/blob/master/ README-FIPS.md ) case,
63- compiling OpenSSL from the source by yourself is a good practice.
60+ or [ the OpenSSL project] [ OpenSSL ] in the non-FIPS or the
61+ [ FIPS] [ OpenSSL README-FIPS] case, compiling OpenSSL from the source by yourself
62+ is a good practice.
6463
6564The following steps are tested in Linux and GCC environment. You can adjust the
6665commands in the steps for a different environment.
@@ -104,20 +103,16 @@ $ OPENSSL_DIR=$HOME/.openssl/openssl-fips-debug-0bf18140f4
104103```
105104
106105The following configuration options are useful in this case.
107- You can check
108- [ OpenSSL installation document] ( https://github.com/openssl/openssl/blob/master/INSTALL.md )
109- for details.
106+ You can check [ OpenSSL installation document] [ OpenSSL INSTALL ] for details.
110107
111108* ` enable-fips ` : Add an option to run with the OpenSSL FIPS module.
112109* ` enable-trace ` : Add an option to enabling tracing log. You can trace logs by
113- implementing a code. See the man page
114- [ OSSL_TRACE(3)] ( https://www.openssl.org/docs/man3.0/man3/OSSL_TRACE.html ) for
110+ implementing a code. See the man page [ OSSL_TRACE(3)] [ OpenSSL OSSL_TRACE ] for
115111 details.
116112* compiler flags
117113 * ` -Wl,-rpath,$(LIBRPATH) ` : Set the runtime shared library path to run the
118114 ` openssl ` command without the ` LD_LIBRARY_PATH ` . You can check
119- [ this document] ( https://github.com/openssl/openssl/blob/master/NOTES-UNIX.md )
120- for details.
115+ [ this document] [ OpenSSL NOTES-UNIX ] for details.
121116 * ` -O0 -g3 -ggdb3 -gdwarf-5 ` : You can set debugging compiler flags.
122117
123118```
@@ -173,8 +168,7 @@ To use OpenSSL 3.0 or later versions in a FIPS-approved manner, you must load th
173168property query is used when fetching cryptographic algorithm implementations.
174169This must be done at the startup of a process to avoid implicitly loading the
175170` default ` provider which has the non-FIPS cryptographic algorithm
176- implementations. See also the man page
177- [ fips_module(7)] ( https://www.openssl.org/docs/manmaster/man7/fips_module.html ) .
171+ implementations. See also the man page [ fips_module(7)] [ OpenSSL fips_module ] .
178172
179173You can set this in your OpenSSL configuration file by either appropriately
180174modifying the default OpenSSL configuration file located at
@@ -227,10 +221,8 @@ $ OPENSSL_CONF=$OPENSSL_DIR/ssl/openssl_fips.cnf \
227221 bundle exec rake test
228222```
229223
230- The GitHub Actions workflow file
231- [ ` test.yml ` ] ( https://github.com/ruby/openssl/tree/master/.github/workflows/test.yml )
232- contains useful information for building OpenSSL/LibreSSL and testing against
233- them.
224+ The GitHub Actions workflow file [ ` test.yml ` ] [ GitHub test.yml ] contains useful
225+ information for building OpenSSL/LibreSSL and testing against them.
234226
235227
236228## Relation with Ruby source tree
@@ -255,7 +247,7 @@ security issue handling procedure for Ruby core.
255247
256248You can either use [ HackerOne] or send an email to security@ruby-lang.org .
257249
258- Please see [ Security] page on ruby-lang.org website for details.
250+ Please see [ Security] [ Ruby Security ] page on ruby-lang.org website for details.
259251
260252Reported problems will be published after a fix is released.
261253
@@ -264,9 +256,16 @@ _Thanks for your contributions!_
264256 _ \- The Ruby OpenSSL team_
265257
266258[ GitHub ] : https://github.com/ruby/openssl
267- [ known issues ] : https://github.com/ruby/openssl/issues
268- [ DeveloperHowTo ] : https://bugs.ruby-lang.org/projects/ruby/wiki/DeveloperHowto
259+ [ Issues ] : https://github.com/ruby/openssl/issues
260+ [ Compare changes ] : https://github.com/ruby/openssl/compare
261+ [ GitHub test/openssl ] : https://github.com/ruby/openssl/tree/master/test/openssl
262+ [ GitHub test.yml ] : https://github.com/ruby/openssl/tree/master/.github/workflows/test.yml
263+ [ Ruby Developer-How-To ] : https://github.com/ruby/ruby/wiki/Developer-How-To
264+ [ Ruby Security ] : https://www.ruby-lang.org/en/security/
269265[ HackerOne ] : https://hackerone.com/ruby
270- [ Security ] : https://www.ruby-lang.org/en/security/
271- [ pull request ] : https://github.com/ruby/openssl/compare
272- [ History.md ] : https://github.com/ruby/openssl/tree/master/History.md
266+ [ OpenSSL ] : https://www.openssl.org/
267+ [ OpenSSL INSTALL ] : https://github.com/openssl/openssl/blob/master/INSTALL.md
268+ [ OpenSSL README-FIPS ] : https://github.com/openssl/openssl/blob/master/README-FIPS.md
269+ [ OpenSSL NOTES-UNIX ] : https://github.com/openssl/openssl/blob/master/NOTES-UNIX.md
270+ [ OpenSSL OSSL_TRACE ] : https://www.openssl.org/docs/manmaster/man3/OSSL_TRACE.html
271+ [ OpenSSL fips_module ] : https://www.openssl.org/docs/manmaster/man7/fips_module.html
0 commit comments