Skip to content

Commit 7abdc3e

Browse files
committedMar 15, 2021
doc: update maintaining-openssl guide
PR-URL: nodejs#37601 Reviewed-By: Matteo Collina <[email protected]> Reviewed-By: Gus Caplan <[email protected]> Reviewed-By: Daniel Bevenius <[email protected]> Reviewed-By: Jiawen Geng <[email protected]> Reviewed-By: Michael Dawson <[email protected]>
1 parent 7ac6265 commit 7abdc3e

File tree

1 file changed

+28
-10
lines changed

1 file changed

+28
-10
lines changed
 

‎doc/guides/maintaining-openssl.md

+28-10
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,18 @@ currently need to generate three PRs as follows:
1616
necessary because differences in 10.x requires that the
1717
configuration files be regenerated specifically for 10.x.
1818

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+
1931
## Requirements
2032
* Linux environment.
2133
* `perl` Only Perl version 5 is tested.
@@ -41,14 +53,18 @@ NASM version 2.11.08
4153

4254
## 1. Obtain and extract new OpenSSL sources
4355

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+
4761
```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
4966
% 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
5268
% git add --all openssl
5369
% git commit openssl
5470
```
@@ -59,10 +75,12 @@ to the relevant value):
5975
deps: upgrade openssl sources to 1.1.0h
6076
6177
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
6382
$ 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
6684
$ git add --all openssl
6785
$ git commit openssl
6886
```
@@ -110,7 +128,7 @@ files if they are changed before committing:
110128
The commit message can be written as (with the openssl version set
111129
to the relevant value):
112130
```text
113-
deps: update archs files for OpenSSL-1.1.0
131+
deps: update archs files for OpenSSL-1.1.1
114132
115133
After an OpenSSL source update, all the config files need to be
116134
regenerated and committed by:

0 commit comments

Comments
 (0)
Please sign in to comment.