mirror of https://github.com/nodejs/node.git
134 lines
4.1 KiB
Markdown
134 lines
4.1 KiB
Markdown
# Maintaining OpenSSL
|
|
|
|
This document describes how to update `deps/openssl/`.
|
|
|
|
## Requirements
|
|
* Linux environment.
|
|
* `perl` Only Perl version 5 is tested.
|
|
* `nasm` (<https://www.nasm.us/>) Version 2.11 or higher is needed.
|
|
* GNU `as` in binutils. Version 2.26 or higher is needed.
|
|
|
|
## 0. Check Requirements
|
|
|
|
```console
|
|
% perl -v
|
|
|
|
This is perl 5, version 22, subversion 1 (v5.22.1) built for
|
|
x86_64-linux-gnu-thread-multi
|
|
(with 60 registered patches, see perl -V for more detail)
|
|
|
|
% as --version
|
|
GNU assembler (GNU Binutils for Ubuntu) 2.26.1
|
|
Copyright (C) 2015 Free Software Foundation, Inc.
|
|
...
|
|
% nasm -v
|
|
NASM version 2.11.08
|
|
```
|
|
|
|
## 1. Obtain and extract new OpenSSL sources
|
|
|
|
Get a new source from <https://www.openssl.org/source/> and extract
|
|
all files into `deps/openssl/openssl`. Then add all files and commit
|
|
them.
|
|
```console
|
|
% cd deps/openssl/
|
|
% rm -rf openssl
|
|
% tar zxf ~/tmp/openssl-1.1.0h.tar.gz
|
|
% mv openssl-1.1.0h openssl
|
|
% git add --all openssl
|
|
% git commit openssl
|
|
```
|
|
|
|
The commit message can be written as (with the openssl version set
|
|
to the relevant value):
|
|
```text
|
|
deps: upgrade openssl sources to 1.1.0h
|
|
|
|
This updates all sources in deps/openssl/openssl by:
|
|
$ cd deps/openssl/
|
|
$ rm -rf openssl
|
|
$ tar zxf ~/tmp/openssl-1.1.0h.tar.gz
|
|
$ mv openssl-1.1.0h openssl
|
|
$ git add --all openssl
|
|
$ git commit openssl
|
|
```
|
|
|
|
#### Updating the QUIC APIs
|
|
|
|
The APIs to support the QUIC implementation are a port of the BoringSSL
|
|
implementation that has not yet landed in OpenSSL. They must be re-applied
|
|
separately after updating the openssl source as described above. The
|
|
current patch implementation can be found in the `deps/openssl/patches`
|
|
directory in the file `0001-deps-add-support-for-BoringSSL-QUIC-APIs.patch`.
|
|
|
|
```console
|
|
% git am deps/openssl/patches 0001-deps-add-support-for-BoringSSL-QUIC-APIs.patch
|
|
```
|
|
|
|
The patch file itself is generated by squashing commits from the
|
|
`OpenSSL_1_1_1d-quic` fork of the Akamai OpenSSL fork located
|
|
[here](https://github.com/akamai/openssl), starting with
|
|
[this commit](https://github.com/akamai/openssl/commit/f910151a5b60eb7b90d274332368226cc67479df),
|
|
then applying additional edits to update the implementation to
|
|
openssl-1.1.1e. As OpenSSL updates are made, additional updates
|
|
to the patch may be necessary to keep the patch in sync.
|
|
|
|
The patch is currently supported only for openssl-1.1.1e.
|
|
|
|
## 2. Execute `make` in `deps/openssl/config` directory
|
|
|
|
Use `make` to regenerate all platform dependent files in
|
|
`deps/openssl/config/archs/`:
|
|
```console
|
|
# On non-Linux machines
|
|
% make gen-openssl
|
|
|
|
# On Linux machines
|
|
% make -C deps/openssl/config
|
|
```
|
|
|
|
## 3. Check diffs
|
|
|
|
Check diffs to ensure updates are right. Even if there are no updates in openssl
|
|
sources, `buildinf.h` files will be updated because they have timestamp
|
|
data in them.
|
|
```console
|
|
% git diff -- deps/openssl
|
|
```
|
|
|
|
*Note*: On Windows, OpenSSL Configure generates a `makefile` that can be
|
|
used for the `nmake` command. The `make` command in step 2 (above) uses
|
|
`Makefile_VC-WIN64A` and `Makefile_VC-WIN32` that are manually
|
|
created. When source files or build options are updated in Windows,
|
|
it needs to change these two Makefiles by hand. If you are not sure,
|
|
please ask @shigeki for details.
|
|
|
|
## 4. Commit and make test
|
|
|
|
Update all architecture dependent files. Do not forget to git add or remove
|
|
files if they are changed before committing:
|
|
```console
|
|
% git add deps/openssl/config/archs
|
|
% git add deps/openssl/openssl/include/crypto/bn_conf.h
|
|
% git add deps/openssl/openssl/include/crypto/dso_conf.h
|
|
% git add deps/openssl/openssl/include/openssl/opensslconf.h
|
|
% git commit
|
|
```
|
|
|
|
The commit message can be written as (with the openssl version set
|
|
to the relevant value):
|
|
```text
|
|
deps: update archs files for OpenSSL-1.1.0
|
|
|
|
After an OpenSSL source update, all the config files need to be
|
|
regenerated and committed by:
|
|
$ make -C deps/openssl/config
|
|
$ git add deps/openssl/config/archs
|
|
$ git add deps/openssl/openssl/include/crypto/bn_conf.h
|
|
$ git add deps/openssl/openssl/include/crypto/dso_conf.h
|
|
$ git add deps/openssl/openssl/include/openssl/opensslconf.h
|
|
$ git commit
|
|
```
|
|
|
|
Finally, build Node.js and run the tests.
|