Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: update instructions for openssl updates #42353

Closed
wants to merge 9 commits into from
18 changes: 11 additions & 7 deletions doc/contributing/maintaining-openssl.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,15 @@
This document describes how to update `deps/openssl/`.

If you need to provide updates across all active release lines you will
currently need to generate three PRs as follows:
currently need to generate four PRs as follows:

* a PR for master which is generated following the instructions
below.
below for OpenSSL 3.0.x.
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
* a PR for 16.x following the instructions in the v16.x-staging version
of this guide.
* a PR for 14.x following the instructions in the v14.x-staging version
of this guide.
* a PR which uses the same commit from the second PR to apply the
* a PR which uses the same commit from the third PR to apply the
updates to the openssl source code, with a new commit generated
by following steps 2 onwards on the 12.x line. This is
necessary because the configuration files have embedded timestamps
Expand Down Expand Up @@ -90,7 +92,7 @@ This updates all sources in deps/openssl/openssl by:
$ git commit openssl
```

### OpenSSL 3.0.0
### OpenSSL 3.0.x
mhdawson marked this conversation as resolved.
Show resolved Hide resolved

```console
% git clone https://github.com/quictls/openssl
Expand All @@ -104,14 +106,15 @@ This updates all sources in deps/openssl/openssl by:
```

```text
deps: upgrade openssl sources to quictls/openssl-3.0.0-alpha-16
deps: upgrade openssl sources to quictls/openssl-3.0.2

This updates all sources in deps/openssl/openssl by:
$ git clone git@github.com:quictls/openssl.git
$ cd openssl
$ git checkout openssl-3.0.2+quic
$ cd ../node/deps/openssl
$ rm -rf openssl
$ cp -R ../openssl openssl
$ cp -R ../../../openssl openssl
$ rm -rf openssl/.git* openssl/.travis*
$ git add --all openssl
$ git commit openssl
Expand Down Expand Up @@ -178,7 +181,7 @@ to the relevant value):
$ git commit
```

### OpenSSL 3.0.0
### OpenSSL 3.0.x

```text
deps: update archs files for quictls/openssl-3.0.0-alpha-16
Expand All @@ -188,6 +191,7 @@ regenerated and committed by:
$ make -C deps/openssl/config
$ git add deps/openssl/config/archs
$ git add deps/openssl/openssl
$ git add deps/openssl/config
mhdawson marked this conversation as resolved.
Show resolved Hide resolved
$ git commit
```

Expand Down