diff options
107 files changed, 170 insertions, 172 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 191d9c9174..85cfb3741c 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -5,7 +5,7 @@ Contributors guide: https://github.com/openssl/openssl/blob/master/CONTRIBUTING. Other than that, provide a description above this comment if there isn't one already -If this fixes a github issue, make sure to have a line saying 'Fixes #XXXX' (without quotes) in the commit message. +If this fixes a GitHub issue, make sure to have a line saying 'Fixes #XXXX' (without quotes) in the commit message. --> ##### Checklist diff --git a/INSTALL.md b/INSTALL.md index 6989410e87..5686415ad8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -167,7 +167,7 @@ Use the following commands to build OpenSSL: ### Windows If you are using Visual Studio, open a Developer Command Prompt and -and issue the following commands to build OpenSSL. +issue the following commands to build OpenSSL. $ perl Configure $ nmake @@ -192,7 +192,7 @@ paragraphs carefully before you install OpenSSL. For security reasons the default system location is by default not writable for unprivileged users. So for the final installation step administrative privileges are required. The default system location and the procedure to -obtain administrative privileges depends on the operating sytem. +obtain administrative privileges depends on the operating system. It is recommended to compile and test OpenSSL with normal user privileges and use administrative privileges only for the final installation step. @@ -482,8 +482,8 @@ be a hex string no more than 64 characters. Enable and Disable Features --------------------------- -Feature options always come in pairs, an option to enable feature `xxxx`, and -and option to disable it: +Feature options always come in pairs, an option to enable feature +`xxxx`, and an option to disable it: [ enable-xxxx | no-xxxx ] @@ -852,7 +852,7 @@ Don't build with support for multi-threaded applications. ### threads Build with support for multi-threaded applications. Most platforms will enable -this by default. However if on a platform where this is not the case then this +this by default. However, if on a platform where this is not the case then this will usually require additional system-dependent options! See [Notes on multi-threading](#notes-on-multi-threading) below. @@ -1457,7 +1457,7 @@ described here. Examine the Makefiles themselves for the full list. Only install the OpenSSL man pages (Unix only). install_html_docs - Only install the OpenSSL html documentation. + Only install the OpenSSL HTML documentation. list-tests Prints a list of all the self test names. @@ -1683,7 +1683,7 @@ to deliver random bytes and a "PRNG not seeded error" will occur. The seeding method can be configured using the `--with-rand-seed` option, which can be used to specify a comma separated list of seed methods. -However in most cases OpenSSL will choose a suitable default method, +However, in most cases OpenSSL will choose a suitable default method, so it is not necessary to explicitly provide this option. Note also that not all methods are available on all platforms. @@ -27,7 +27,7 @@ OpenSSL 3.0 will not be accidentially used. * The algorithm specific public key command line applications have been deprecated. These include dhparam, gendsa and others. The pkey - alternatives should be used intead: pkey, pkeyparam and genpkey. + alternatives should be used instead: pkey, pkeyparam and genpkey. * X509 certificates signed using SHA1 are no longer allowed at security level 1 or higher. The default security level for TLS is 1, so certificates signed using SHA1 are by default no longer trusted to @@ -57,12 +57,12 @@ OpenSSL 3.0 * Removed the heartbeat message in DTLS feature. * Added EVP_KDF, an EVP layer KDF API, and a generic EVP_PKEY to EVP_KDF bridge. - * All of the low level MD2, MD4, MD5, MDC2, RIPEMD160, SHA1, SHA224, + * All of the low-level MD2, MD4, MD5, MDC2, RIPEMD160, SHA1, SHA224, SHA256, SHA384, SHA512 and Whirlpool digest functions have been deprecated. - * All of the low level AES, Blowfish, Camellia, CAST, DES, IDEA, RC2, + * All of the low-level AES, Blowfish, Camellia, CAST, DES, IDEA, RC2, RC4, RC5 and SEED cipher functions have been deprecated. - * All of the low level DH, DSA, ECDH, ECDSA and RSA public key functions + * All of the low-level DH, DSA, ECDH, ECDSA and RSA public key functions have been deprecated. * SSL 3, TLS 1.0, TLS 1.1, and DTLS 1.0 only work at security level 0. @@ -681,7 +681,7 @@ OpenSSL 1.0.0 Known issues in OpenSSL 1.0.0m: * EAP-FAST and other applications using tls_session_secret_cb - wont resume sessions. Fixed in 1.0.0n-dev + won't resume sessions. Fixed in 1.0.0n-dev * Compilation failure of s3_pkt.c on some platforms due to missing `<limits.h>` include. Fixed in 1.0.0n-dev @@ -1189,7 +1189,7 @@ OpenSSL 0.9.x * Enhanced chain verification using key identifiers. * New sign and verify options to 'dgst' application. * Support for DER and PEM encoded messages in 'smime' application. - * New 'rsautl' application, low level RSA utility. + * New 'rsautl' application, low-level RSA utility. * MD4 now included. * Bugfix for SSL rollback padding check. * Support for external crypto devices [1]. @@ -1241,7 +1241,7 @@ OpenSSL 0.9.x * BIGNUM library bug fixes * Faster DSA parameter generation * Enhanced support for Alpha Linux - * Experimental MacOS support + * Experimental macOS support ### Major changes between OpenSSL 0.9.3 and OpenSSL 0.9.4 [9 Aug 1999] diff --git a/NOTES.ANDROID b/NOTES.ANDROID index 0173eca73b..087d5e6f49 100644 --- a/NOTES.ANDROID +++ b/NOTES.ANDROID @@ -6,8 +6,8 @@ ------------------- Beside basic tools like perl and make you'll need to download the Android - NDK. It's available for Linux, Mac OS X and Windows, but only Linux - version was actually tested. There is no reason to believe that Mac OS X + NDK. It's available for Linux, macOS and Windows, but only Linux + version was actually tested. There is no reason to believe that macOS wouldn't work. And as for Windows, it's unclear which "shell" would be suitable, MSYS2 might have best chances. NDK version should play lesser role, the goal is to support a range of most recent versions. @@ -18,7 +18,7 @@ An ANSI C compiled is needed among other things. This means that VAX C is not and will not be supported. - We have only tested with DEC C (a.k.a HP VMS C / VSI C) and require + We have only tested with DEC C (aka HP VMS C / VSI C) and require version 7.1 or later. Compiling with a different ANSI C compiler may require some work. @@ -18,7 +18,7 @@ For this option you can use Cygwin. |