root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity

Point to new docs location 

Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Paul Dale <ppzgs1@gmail.com>
Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/27331)
This commit is contained in:
Jon Ericson 2025-04-09 22:04:41 -07:00 committed by Matt Caswell
parent de67f90815
commit f014892d9f
12 changed files with 32 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
NEWS.md
View File

@ -2069,7 +2069,7 @@ OpenSSL 0.9.x
[CVE-2006-2940]: https://www.openssl.org/news/vulnerabilities.html#CVE-2006-2940 [CVE-2006-2940]: https://www.openssl.org/news/vulnerabilities.html#CVE-2006-2940
[CVE-2006-2937]: https://www.openssl.org/news/vulnerabilities.html#CVE-2006-2937 [CVE-2006-2937]: https://www.openssl.org/news/vulnerabilities.html#CVE-2006-2937
[CVE-2005-2969]: https://www.openssl.org/news/vulnerabilities.html#CVE-2005-2969 [CVE-2005-2969]: https://www.openssl.org/news/vulnerabilities.html#CVE-2005-2969
[OpenSSL Guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html [OpenSSL Guide]: https://docs.openssl.org/master/man7/ossl-guide-introduction
[CHANGES.md]: ./CHANGES.md [CHANGES.md]: ./CHANGES.md
[README-QUIC.md]: ./README-QUIC.md [README-QUIC.md]: ./README-QUIC.md
[issue tracker]: https://github.com/openssl/openssl/issues [issue tracker]: https://github.com/openssl/openssl/issues

2
README-FIPS.md
View File

@ -168,7 +168,7 @@ Using the FIPS Module in applications
Documentation about using the FIPS module is available on the [fips_module(7)] Documentation about using the FIPS module is available on the [fips_module(7)]
manual page. manual page.
[fips_module(7)]: https://www.openssl.org/docs/manmaster/man7/fips_module.html [fips_module(7)]: https://docs.openssl.org/master/man7/fips_module
Entropy Source Entropy Source
============== ==============

4
README-PROVIDERS.md
View File

@ -20,7 +20,7 @@ distribute their own providers which can be added to OpenSSL dynamically.
Documentation about writing providers is available on the [provider(7)] Documentation about writing providers is available on the [provider(7)]
manual page. manual page.
[provider(7)]: https://www.openssl.org/docs/manmaster/man7/provider.html [provider(7)]: https://docs.openssl.org/master/man7/provider
The Default Provider The Default Provider
-------------------- --------------------
@ -88,7 +88,7 @@ Providers to be loaded can be specified in the OpenSSL config file.
See the [config(5)] manual page for information about how to configure See the [config(5)] manual page for information about how to configure
providers via the config file, and how to automatically activate them. providers via the config file, and how to automatically activate them.
[config(5)]: https://www.openssl.org/docs/manmaster/man5/config.html [config(5)]: https://docs.openssl.org/master/man5/config
The following is a minimal config file example to load and activate both The following is a minimal config file example to load and activate both
the legacy and the default provider in the default library context. the legacy and the default provider in the default library context.

6
README-QUIC.md
View File

@ -98,11 +98,11 @@ use this dedicated server example instead.
For more information about implementing QUIC servers with OpenSSL, refer to the For more information about implementing QUIC servers with OpenSSL, refer to the
[OpenSSL Guide] and the [openssl-quic(7) manual page]. [OpenSSL Guide] and the [openssl-quic(7) manual page].
[openssl-quic(7) manual page]: https://www.openssl.org/docs/manmaster/man7/openssl-quic.html [openssl-quic(7) manual page]: https://docs.openssl.org/master/man7/openssl-quic
[OpenSSL Guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html [OpenSSL Guide]: https://docs.openssl.org/master/man7/ossl-guide-introduction
[DDD]: https://github.com/openssl/openssl/tree/master/doc/designs/ddd [DDD]: https://github.com/openssl/openssl/tree/master/doc/designs/ddd
[found in the source tree under `doc/designs/ddd`]: ./doc/designs/ddd/ [found in the source tree under `doc/designs/ddd`]: ./doc/designs/ddd/
[demo found in `demos/http3`]: ./demos/http3/ [demo found in `demos/http3`]: ./demos/http3/
[QUIC Introduction]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-quic-introduction.html [QUIC Introduction]: https://docs.openssl.org/master/man7/ossl-guide-quic-introduction
[RFC 9114]: https://tools.ietf.org/html/rfc9114 [RFC 9114]: https://tools.ietf.org/html/rfc9114
[ALPN ids]: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids [ALPN ids]: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids

14
README.md
View File

@ -149,10 +149,12 @@ Manual Pages
The manual pages for the master branch and all current stable releases are The manual pages for the master branch and all current stable releases are
available online. available online.
- [OpenSSL master](https://www.openssl.org/docs/manmaster) - [OpenSSL master](https://docs.openssl.org/master/)
- [OpenSSL 3.0](https://www.openssl.org/docs/man3.0) - [OpenSSL 3.5](https://docs.openssl.org/3.5/)
- [OpenSSL 3.1](https://www.openssl.org/docs/man3.1) - [OpenSSL 3.4](https://docs.openssl.org/3.4/)
- [OpenSSL 3.2](https://www.openssl.org/docs/man3.2) - [OpenSSL 3.3](https://docs.openssl.org/3.3/)
- [OpenSSL 3.2](https://docs.openssl.org/3.2/)
- [OpenSSL 3.0](https://docs.openssl.org/3.0/)
Demos Demos
----- -----
@ -217,7 +219,7 @@ All rights reserved.
"OpenSSL Wiki" "OpenSSL Wiki"
[ossl-guide-migration(7ossl)]: [ossl-guide-migration(7ossl)]:
<https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html> <https://docs.openssl.org/master/man7/ossl-guide-migration>
"OpenSSL Migration Guide" "OpenSSL Migration Guide"
[RFC 8446]: [RFC 8446]:
@ -234,7 +236,7 @@ All rights reserved.
"List of third party OpenSSL binaries" "List of third party OpenSSL binaries"
[OpenSSL Guide]: [OpenSSL Guide]:
<https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html> <https://docs.openssl.org/master/man7/ossl-guide-introduction>
"An introduction to OpenSSL" "An introduction to OpenSSL"
<!-- Logos and Badges --> <!-- Logos and Badges -->

4
demos/guide/README.md
View File

@ -86,5 +86,5 @@ most easily be seen in action in our quic interop container, buildable from
<!-- Links --> <!-- Links -->
[guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html [guide]: https://docs.openssl.org/master/man7/ossl-guide-introduction
[TLS Introduction]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-tls-introduction.html [TLS Introduction]: https://docs.openssl.org/master/man7/ossl-guide-tls-introduction

2
demos/sslecho/A-SSL-Docs.txt
View File

@ -1,6 +1,6 @@
Useful Links: Useful Links:
OpenSSL API Documentation: https://www.openssl.org/docs OpenSSL API Documentation: https://docs.openssl.org/master
Github: https://github.com/openssl/openssl Github: https://github.com/openssl/openssl

2
dev/release-aux/openssl-announce-pre-release.tmpl
View File

@ -15,7 +15,7 @@
Specific notes on upgrading to OpenSSL $series from previous versions are Specific notes on upgrading to OpenSSL $series from previous versions are
available in the OpenSSL Migration Guide, here: available in the OpenSSL Migration Guide, here:
https://www.openssl.org/docs/manmaster/man7/ossl-guide-migration.html https://docs.openssl.org/master/man7/ossl-guide-migration
The $label release is available for download via HTTPS and FTP from the The $label release is available for download via HTTPS and FTP from the
following master locations (you can find the various FTP mirrors under following master locations (you can find the various FTP mirrors under

2
dev/release-aux/openssl-announce-release.tmpl
View File

@ -14,7 +14,7 @@
Specific notes on upgrading to OpenSSL $series from previous versions are Specific notes on upgrading to OpenSSL $series from previous versions are
available in the OpenSSL Migration Guide, here: available in the OpenSSL Migration Guide, here:
https://www.openssl.org/docs/man$series/man7/ossl-guide-migration.html https://docs.openssl.org/$series/man7/ossl-guide-migration.html
OpenSSL $release is available for download via HTTPS and FTP from the OpenSSL $release is available for download via HTTPS and FTP from the
following master locations (you can find the various FTP mirrors under following master locations (you can find the various FTP mirrors under

8
doc/HOWTO/certificates.txt
View File

@ -11,12 +11,12 @@ Your role can be one or several of:
- Certificate authority - Certificate authority
This file is for users who wish to get a certificate of their own. This file is for users who wish to get a certificate of their own.
Certificate authorities should read https://www.openssl.org/docs/apps/ca.html. Certificate authorities should read https://docs.openssl.org/master/man1/openssl-ca.
In all the cases shown below, the standard configuration file, as In all the cases shown below, the standard configuration file, as
compiled into openssl, will be used. You may find it in /etc/, compiled into openssl, will be used. You may find it in /etc/,
/usr/local/ssl/ or somewhere else. By default the file is named /usr/local/ssl/ or somewhere else. By default the file is named
openssl.cnf and is described at https://www.openssl.org/docs/apps/config.html. openssl.cnf and is described at https://docs.openssl.org/master/man5/config.
You can specify a different configuration file using the You can specify a different configuration file using the
'-config {file}' argument with the commands shown below. '-config {file}' argument with the commands shown below.
@ -35,7 +35,7 @@ you want an RSA private key, or if you want a DSA private key:
The private keys created by these commands are not passphrase protected; The private keys created by these commands are not passphrase protected;
it might or might not be the desirable thing. Further information on how to it might or might not be the desirable thing. Further information on how to
create private keys can be found at https://www.openssl.org/docs/HOWTO/keys.txt. create private keys can be found at https://github.com/openssl/openssl/blob/master/doc/HOWTO/keys.txt.
The rest of this text assumes you have a private key in the file privkey.pem. The rest of this text assumes you have a private key in the file privkey.pem.
@ -77,7 +77,7 @@ with a certificate authority, or if you just want to create a test
certificate for yourself. This is similar to creating a certificate certificate for yourself. This is similar to creating a certificate
request, but creates a certificate instead of a certificate request. request, but creates a certificate instead of a certificate request.
This is NOT the recommended way to create a CA certificate, see This is NOT the recommended way to create a CA certificate, see
https://www.openssl.org/docs/apps/ca.html. https://docs.openssl.org/master/man1/openssl-ca.
openssl req -new -x509 -key privkey.pem -out cacert.pem -days 1095 openssl req -new -x509 -key privkey.pem -out cacert.pem -days 1095

2
doc/designs/evp-cipher-pipeline.md
View File

@ -15,7 +15,7 @@ chunks of data in one cipher update call, thereby allowing the provided
implementation to take advantage of parallel computing. This is very beneficial implementation to take advantage of parallel computing. This is very beneficial
for hardware accelerators as pipeline amortizes the latency over multiple for hardware accelerators as pipeline amortizes the latency over multiple
chunks. Our libssl makes use of pipeline as discussed in chunks. Our libssl makes use of pipeline as discussed in
[here](https://www.openssl.org/docs/manmaster/man3/SSL_CTX_set_max_pipelines.html). [here](https://docs.openssl.org/master/man3/SSL_CTX_set_max_pipelines).
Pipelining with ENGINE Pipelining with ENGINE
----------------------- -----------------------

14
doc/designs/quic-design/quic-api.md
View File

@ -1214,7 +1214,7 @@ Options:
#### MTU Signalling #### MTU Signalling
**See also:** **See also:**
[BIO_s_dgram_pair(3)](https://www.openssl.org/docs/manmaster/man3/BIO_s_dgram_pair.html) [BIO_s_dgram_pair(3)](https://docs.openssl.org/master/man3/BIO_s_dgram_pair)
`BIO_dgram_get_mtu` (`BIO_CTRL_DGRAM_GET_MTU`) and `BIO_dgram_set_mtu` `BIO_dgram_get_mtu` (`BIO_CTRL_DGRAM_GET_MTU`) and `BIO_dgram_set_mtu`
(`BIO_CTRL_DGRAM_SET_MTU`) already exist for `BIO_s_dgram` and are implemented (`BIO_CTRL_DGRAM_SET_MTU`) already exist for `BIO_s_dgram` and are implemented
@ -1229,7 +1229,7 @@ from the OS using `BIO_CTRL_DGRAM_QUERY_MTU`.
#### `BIO_sendmmsg` and `BIO_recvmmsg` #### `BIO_sendmmsg` and `BIO_recvmmsg`
**See also:** **See also:**
[BIO_sendmmsg(3)](https://www.openssl.org/docs/manmaster/man3/BIO_sendmmsg.html) [BIO_sendmmsg(3)](https://docs.openssl.org/master/man3/BIO_sendmmsg)
The BIO interface features a new high-performance API for the execution of The BIO interface features a new high-performance API for the execution of
multiple read or write operations in a single system call, on supported OSes. On multiple read or write operations in a single system call, on supported OSes. On
@ -1265,7 +1265,7 @@ corresponding `BIO_meth` getter/setter functions.
#### Truncation Mode #### Truncation Mode
**See also:** **See also:**
[BIO_s_dgram_pair(3)](https://www.openssl.org/docs/manmaster/man3/BIO_s_dgram_pair.html) [BIO_s_dgram_pair(3)](https://docs.openssl.org/master/man3/BIO_s_dgram_pair)
The controls `BIO_dgram_set_no_trunc` (`BIO_CTRL_DGRAM_SET_NO_TRUNC`) and The controls `BIO_dgram_set_no_trunc` (`BIO_CTRL_DGRAM_SET_NO_TRUNC`) and
`BIO_dgram_get_no_trunc` (`BIO_CTRL_DGRAM_GET_NO_TRUNC`) are introduced. This is `BIO_dgram_get_no_trunc` (`BIO_CTRL_DGRAM_GET_NO_TRUNC`) are introduced. This is
@ -1278,7 +1278,7 @@ For compatibility, the default behaviour is off.
#### Capability Negotiation #### Capability Negotiation
**See also:** **See also:**
[BIO_s_dgram_pair(3)](https://www.openssl.org/docs/manmaster/man3/BIO_s_dgram_pair.html) [BIO_s_dgram_pair(3)](https://docs.openssl.org/master/man3/BIO_s_dgram_pair)
Where a `BIO_s_dgram_pair` is used, there is the potential for such a memory BIO Where a `BIO_s_dgram_pair` is used, there is the potential for such a memory BIO
to be used by existing application code which is being adapted for use with to be used by existing application code which is being adapted for use with
@ -1314,7 +1314,7 @@ The usage is as follows:
#### Local Address Support #### Local Address Support
**See also:** **See also:**
[BIO_s_dgram_pair(3)](https://www.openssl.org/docs/manmaster/man3/BIO_s_dgram_pair.html) [BIO_s_dgram_pair(3)](https://docs.openssl.org/master/man3/BIO_s_dgram_pair)
Support for local addressing (the reception of destination addresses for Support for local addressing (the reception of destination addresses for
incoming packets, and the specification of source addresses for outgoing incoming packets, and the specification of source addresses for outgoing
@ -1349,7 +1349,7 @@ enabled).
#### `BIO_s_dgram_pair` #### `BIO_s_dgram_pair`
**See also:** **See also:**
[BIO_s_dgram_pair(3)](https://www.openssl.org/docs/manmaster/man3/BIO_s_dgram_pair.html) [BIO_s_dgram_pair(3)](https://docs.openssl.org/master/man3/BIO_s_dgram_pair)
A new BIO implementation, `BIO_s_dgram_pair`, is provided. This is similar to A new BIO implementation, `BIO_s_dgram_pair`, is provided. This is similar to
the existing BIO pair but provides datagram semantics. It provides full support the existing BIO pair but provides datagram semantics. It provides full support
@ -1403,7 +1403,7 @@ local addressing.
A new predicate function `BIO_err_is_non_fatal` is defined which determines if A new predicate function `BIO_err_is_non_fatal` is defined which determines if
an error code represents a non-fatal or transient error. For details, see an error code represents a non-fatal or transient error. For details, see
[BIO_sendmmsg(3)](https://www.openssl.org/docs/manmaster/man3/BIO_sendmmsg.html). [BIO_sendmmsg(3)](https://docs.openssl.org/master/man3/BIO_sendmmsg).
Q & A Q & A
----- -----