Commit 5d79373
doc: update maintaining-openssl guide
PR-URL: #37601
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Gus Caplan <me@gus.host>
Reviewed-By: Daniel Bevenius <daniel.bevenius@gmail.com>
Reviewed-By: Jiawen Geng <technicalcute@gmail.com>
Reviewed-By: Michael Dawson <midawson@redhat.com>1 parent c2cb153 commit 5d79373
1 file changed
Lines changed: 28 additions & 10 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -16,6 +16,18 @@ currently need to generate three PRs as follows: | |||
| 16 | 16 | necessary because differences in 10.x requires that the | |
| 17 | 17 | configuration files be regenerated specifically for 10.x. | |
| 18 | 18 | ||
| 19 | + ## Use of the quictls/openssl fork | ||
| 20 | + | ||
| 21 | + Node.js currently uses the quictls/openssl fork, which closely tracks | ||
| 22 | + the main openssl/openssl releases with the addition of APIs to support | ||
| 23 | + the QUIC protocol. | ||
| 24 | + | ||
| 25 | + Details on the fork, as well as the latest sources, can be found at | ||
| 26 | + <https://github.com/quictls/openssl>. | ||
| 27 | + | ||
| 28 | + Branches are used per OpenSSL version (for instance, | ||
| 29 | + <https://github.com/quictls/openssl/tree/OpenSSL_1_1_1j+quic)>. | ||
| 30 | + | ||
| 19 | 31 | ## Requirements | |
| 20 | 32 | * Linux environment. | |
| 21 | 33 | * `perl` Only Perl version 5 is tested. | |
@@ -41,14 +53,18 @@ NASM version 2.11.08 | |||
| 41 | 53 | ||
| 42 | 54 | ## 1. Obtain and extract new OpenSSL sources | |
| 43 | 55 | ||
| 44 | - Get a new source from <https://www.openssl.org/source/> and extract | ||
| 45 | - all files into `deps/openssl/openssl`. Then add all files and commit | ||
| 46 | - them. | ||
| 56 | + Get a new source from <https://github.com/quictls/openssl/tree/OpenSSL_1_1_1j+quic> | ||
| 57 | + and copy all files into `deps/openssl/openssl`. Then add all files and commit | ||
| 58 | + them. (The link above, and the branch, will change with each new OpenSSL | ||
| 59 | + release). | ||
| 60 | + | ||
| 47 | 61 | ```console | |
| 48 | - % cd deps/openssl/ | ||
| 62 | + % git clone https://github.com/quictls/openssl | ||
| 63 | + % cd openssl | ||
| 64 | + % git checkout OpenSSL_1_1_1j+quic | ||
| 65 | + % cd ../node/deps/openssl | ||
| 49 | 66 | % rm -rf openssl | |
| 50 | - % tar zxf ~/tmp/openssl-1.1.0h.tar.gz | ||
| 51 | - % mv openssl-1.1.0h openssl | ||
| 67 | + % cp -R ../../../openssl openssl | ||
| 52 | 68 | % git add --all openssl | |
| 53 | 69 | % git commit openssl | |
| 54 | 70 | ``` | |
@@ -59,10 +75,12 @@ to the relevant value): | |||
| 59 | 75 | deps: upgrade openssl sources to 1.1.0h | |
| 60 | 76 | ||
| 61 | 77 | This updates all sources in deps/openssl/openssl by: | |
| 62 | - $ cd deps/openssl/ | ||
| 78 | + $ git clone https://github.com/quictls/openssl | ||
| 79 | + $ cd openssl | ||
| 80 | + $ git checkout OpenSSL_1_1_1j+quic | ||
| 81 | + $ cd ../node/deps/openssl | ||
| 63 | 82 | $ rm -rf openssl | |
| 64 | - $ tar zxf ~/tmp/openssl-1.1.0h.tar.gz | ||
| 65 | - $ mv openssl-1.1.0h openssl | ||
| 83 | + $ cp -R ../openssl openssl | ||
| 66 | 84 | $ git add --all openssl | |
| 67 | 85 | $ git commit openssl | |
| 68 | 86 | ``` | |
@@ -110,7 +128,7 @@ files if they are changed before committing: | |||
| 110 | 128 | The commit message can be written as (with the openssl version set | |
| 111 | 129 | to the relevant value): | |
| 112 | 130 | ```text | |
| 113 | - deps: update archs files for OpenSSL-1.1.0 | ||
| 131 | + deps: update archs files for OpenSSL-1.1.1 | ||
| 114 | 132 | ||
| 115 | 133 | After an OpenSSL source update, all the config files need to be | |
| 116 | 134 | regenerated and committed by: | |
0 commit comments