Commit 11ed1e6
deps,doc: move openssl maintenance guide to doc
The maintainenance guides are mostly in doc/guides-maintaining-*.md, so
move the OpenSSL one there, too.
PR-URL: #32209
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Reviewed-By: Richard Lau <riclau@uk.ibm.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent b5b7bf5 commit 11ed1e6
2 files changed
Lines changed: 34 additions & 32 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -76,4 +76,4 @@ Please refer [config/opensslconf_asm.h](config/opensslconf_asm.h) for details. | |||
| 76 | 76 | ||
| 77 | 77 | ### Upgrading OpenSSL | |
| 78 | 78 | ||
| 79 | - Please refer [config/README.md](config/README.md). | ||
| 79 | + Please refer to [maintaining-openssl](../../doc/guides/maintaining-openssl.md). | ||
Lines changed: 33 additions & 31 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,44 +1,46 @@ | |||
| 1 | - ## Upgrading OpenSSL | ||
| 1 | + # Maintaining OpenSSL | ||
| 2 | 2 | ||
| 3 | - ### Requirements | ||
| 4 | - - Linux environment (Only CentOS7.1 and Ubuntu16 are tested) | ||
| 5 | - - `perl` Only Perl version 5 is tested. | ||
| 6 | - - `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed. | ||
| 7 | - - GNU `as` in binutils. The version of 2.26 or higher is needed. | ||
| 3 | + This document describes how to update `deps/openssl/`. | ||
| 8 | 4 | ||
| 9 | - ### 0. Check Requirements | ||
| 5 | + ## Requirements | ||
| 6 | + * Linux environment | ||
| 7 | + * `perl` Only Perl version 5 is tested. | ||
| 8 | + * `nasm` (http://www.nasm.us/) The version of 2.11 or higher is needed. | ||
| 9 | + * GNU `as` in binutils. The version of 2.26 or higher is needed. | ||
| 10 | + | ||
| 11 | + ## 0. Check Requirements | ||
| 10 | 12 | ||
| 11 | 13 | ```sh | |
| 12 | - $ perl -v | ||
| 14 | + % perl -v | ||
| 13 | 15 | ||
| 14 | 16 | This is perl 5, version 22, subversion 1 (v5.22.1) built for | |
| 15 | 17 | x86_64-linux-gnu-thread-multi | |
| 16 | 18 | (with 60 registered patches, see perl -V for more detail) | |
| 17 | 19 | ||
| 18 | - $ as --version | ||
| 20 | + % as --version | ||
| 19 | 21 | GNU assembler (GNU Binutils for Ubuntu) 2.26.1 | |
| 20 | 22 | Copyright (C) 2015 Free Software Foundation, Inc. | |
| 21 | 23 | ... | |
| 22 | - $ nasm -v | ||
| 24 | + % nasm -v | ||
| 23 | 25 | NASM version 2.11.08 | |
| 24 | 26 | ``` | |
| 25 | 27 | ||
| 26 | - ### 1. Obtain and extract new OpenSSL sources | ||
| 28 | + ## 1. Obtain and extract new OpenSSL sources | ||
| 27 | 29 | ||
| 28 | 30 | Get a new source from https://www.openssl.org/source/ and extract | |
| 29 | 31 | all files into `deps/openssl/openssl`. Then add all files and commit | |
| 30 | 32 | them. | |
| 31 | 33 | ```sh | |
| 32 | - $ cd deps/openssl/ | ||
| 33 | - $ rm -rf openssl | ||
| 34 | - $ tar zxf ~/tmp/openssl-1.1.0h.tar.gz | ||
| 35 | - $ mv openssl-1.1.0h openssl | ||
| 36 | - $ git add --all openssl | ||
| 37 | - $ git commit openssl | ||
| 34 | + % cd deps/openssl/ | ||
| 35 | + % rm -rf openssl | ||
| 36 | + % tar zxf ~/tmp/openssl-1.1.0h.tar.gz | ||
| 37 | + % mv openssl-1.1.0h openssl | ||
| 38 | + % git add --all openssl | ||
| 39 | + % git commit openssl | ||
| 38 | 40 | ```` | |
| 39 | 41 | ||
| 40 | 42 | The commit message can be (with the openssl version set to the relevant value): | |
| 41 | - ``` | ||
| 43 | + ```text | ||
| 42 | 44 | deps: upgrade openssl sources to 1.1.0h | |
| 43 | 45 | ||
| 44 | 46 | This updates all sources in deps/openssl/openssl by: | |
@@ -50,22 +52,22 @@ This updates all sources in deps/openssl/openssl by: | |||
| 50 | 52 | $ git commit openssl | |
| 51 | 53 | ``` | |
| 52 | 54 | ||
| 53 | - ### 2. Execute `make` in `deps/openssl/config` directory | ||
| 55 | + ## 2. Execute `make` in `deps/openssl/config` directory | ||
| 54 | 56 | ||
| 55 | 57 | Use `make` to regenerate all platform dependent files in | |
| 56 | 58 | `deps/openssl/config/archs/`: | |
| 57 | 59 | ```sh | |
| 58 | - $ cd deps/openssl/config; make | ||
| 60 | + % cd deps/openssl/config; make | ||
| 59 | 61 | ``` | |
| 60 | 62 | ||
| 61 | - ### 3. Check diffs | ||
| 63 | + ## 3. Check diffs | ||
| 62 | 64 | ||
| 63 | 65 | Check diffs if updates are right. Even if no updates in openssl | |
| 64 | 66 | sources, `buildinf.h` files will be updated for they have a timestamp | |
| 65 | 67 | data in them. | |
| 66 | 68 | ```sh | |
| 67 | - $ cd deps/openssl/config | ||
| 68 | - $ git diff | ||
| 69 | + % cd deps/openssl/config | ||
| 70 | + % git diff | ||
| 69 | 71 | ``` | |
| 70 | 72 | ||
| 71 | 73 | *Note*: On Windows, OpenSSL Configure generates `makefile` that can be | |
@@ -75,20 +77,20 @@ created. When source files or build options are updated in Windows, | |||
| 75 | 77 | it needs to change these two Makefiles by hand. If you are not sure, | |
| 76 | 78 | please ask @shigeki for details. | |
| 77 | 79 | ||
| 78 | - ### 4. Commit and make test | ||
| 80 | + ## 4. Commit and make test | ||
| 79 | 81 | ||
| 80 | 82 | Update all architecture dependent files. Do not forget to git add or remove | |
| 81 | 83 | files if they are changed before commit: | |
| 82 | 84 | ```sh | |
| 83 | - $ git add deps/openssl/config/archs | ||
| 84 | - $ git add deps/openssl/openssl/crypto/include/internal/bn_conf.h | ||
| 85 | - $ git add deps/openssl/openssl/crypto/include/internal/dso_conf.h | ||
| 86 | - $ git add deps/openssl/openssl/include/openssl/opensslconf.h | ||
| 87 | - $ git commit | ||
| 85 | + % git add deps/openssl/config/archs | ||
| 86 | + % git add deps/openssl/openssl/crypto/include/internal/bn_conf.h | ||
| 87 | + % git add deps/openssl/openssl/crypto/include/internal/dso_conf.h | ||
| 88 | + % git add deps/openssl/openssl/include/openssl/opensslconf.h | ||
| 89 | + % git commit | ||
| 88 | 90 | ``` | |
| 89 | 91 | ||
| 90 | 92 | The commit message can be (with the openssl version set to the relevant value): | |
| 91 | - ``` | ||
| 93 | + ```text | ||
| 92 | 94 | deps: update archs files for OpenSSL-1.1.0 | |
| 93 | 95 | ||
| 94 | 96 | After an OpenSSL source update, all the config files need to be regenerated and | |
@@ -102,4 +104,4 @@ The commit message can be (with the openssl version set to the relevant value): | |||
| 102 | 104 | $ git commit | |
| 103 | 105 | ``` | |
| 104 | 106 | ||
| 105 | - Finally, build Node and run tests. | ||
| 107 | + Finally, build Node.js and run tests. | ||
0 commit comments