diff options
author | Matt Caswell <matt@openssl.org> | 2023-10-25 14:10:59 +0200 |
---|---|---|
committer | Hugo Landau <hlandau@openssl.org> | 2023-10-30 08:54:00 +0100 |
commit | ada33e98f53ab02dc4d6e8259c9e9edb6cd5c90c (patch) | |
tree | 7d2b7449ac16545c246da82b4cd007abd3960042 /README-QUIC.md | |
parent | Add a reference for HTTP/3 (diff) | |
download | openssl-ada33e98f53ab02dc4d6e8259c9e9edb6cd5c90c.tar.xz openssl-ada33e98f53ab02dc4d6e8259c9e9edb6cd5c90c.zip |
Add a separate README for the guide demos
Point users at the actual guide, and also explain about LD_LIBRARY_PATH
Reviewed-by: Hugo Landau <hlandau@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22505)
Diffstat (limited to 'README-QUIC.md')
-rw-r--r-- | README-QUIC.md | 20 |
1 files changed, 9 insertions, 11 deletions
diff --git a/README-QUIC.md b/README-QUIC.md index 3c5720e90b..554fe9bc2b 100644 --- a/README-QUIC.md +++ b/README-QUIC.md @@ -7,11 +7,10 @@ client. Users interested in using the new QUIC functionality are encouraged to look at some of the following resources: -- The new [OpenSSL Guide], which provides introductory guides - on the use of TLS, QUIC, and other OpenSSL functionality. See the - [ossl-guide-introduction(7) manual page] for the index. +- The new [OpenSSL Guide], which provides introductory guides on the use of TLS, + QUIC, and other OpenSSL functionality. - The [OpenSSL Guide] incorporates various code samples. The complete source - for these can be [found in the source tree under `demos\guide`](./demos/guide/). + for these can be [found in the source tree under `demos/guide`](./demos/guide/). - The [openssl-quic(7) manual page], which provides a basic reference overview of QUIC functionality and how use of QUIC differs from use of TLS with regard to our API. @@ -33,9 +32,9 @@ QUIC delivers a number of advantages such as support for multiple streams of communication; it is the basis for HTTP/3 [RFC 9114]; fast connection initiation; and connection migration (enabling a connection to survive IP address changes). For a more complete description of what QUIC is and its -advantages see the [QUIC Introduction] in the OpenSSL Guide. +advantages see the [QUIC Introduction] in the [OpenSSL Guide]. -For a more comprehensive overview of OpenSSL's QUIC implementation, see the +For a comprehensive overview of OpenSSL's QUIC implementation, see the [openssl-quic(7) manual page]. ### How can I use HTTP/3 with OpenSSL? @@ -63,7 +62,7 @@ $ openssl s_client -quic -alpn myalpn -connect host:port In the above example replace `host` with the hostname of the server (e.g. `www.example.com`) and `port` with the port for the server (e.g. `443`). Replace `myalpn` with the Application Layer Protocol to use (e.g.`h3` represents -HTTP/3). IANA matains a standard list of [ALPN ids] that can be used. +HTTP/3). IANA maintains a standard list of [ALPN ids] that can be used. This example connects to a QUIC server and opens a single bidirectional stream. Data can be passed via stdin/stdout as usual. This allows test usage of QUIC @@ -72,11 +71,10 @@ HTTP/3 so connecting to an HTTP/3 server should be possible but sending an HTTP/3 request or receiving any response data is not. [openssl-quic(7) manual page]: https://www.openssl.org/docs/manmaster/man7/openssl-quic.html -[OpenSSL guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html +[OpenSSL Guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html [DDD]: https://github.com/openssl/openssl/tree/master/doc/designs/ddd [found in the source tree under `doc/designs/ddd`]: ./doc/designs/ddd/ [demo found in `demos/http3`]: ./demos/http3/ -[openssl-quic(7) manual page]: https://www.openssl.org/docs/manmaster/man7/openssl-quic.html -[QUIC Introduction](https://www.openssl.org/docs/manmaster/man7/ossl-guide-quic-introduction.html) +[QUIC Introduction]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-quic-introduction.html [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
\ No newline at end of file +[ALPN ids]: https://www.iana.org/assignments/tls-extensiontype-values/tls-extensiontype-values.xhtml#alpn-protocol-ids |