diff options
| author | Matt Caswell <matt@openssl.org> | 2023-10-30 12:17:30 +0000 |
|---|---|---|
| committer | Hugo Landau <hlandau@openssl.org> | 2023-11-02 08:14:46 +0000 |
| commit | cb8107b632661d2ae538961424768f0ed074fcf6 (patch) | |
| tree | b3e50a5e2b7763699ae8275a4dfecdfcebdde773 /demos | |
| parent | 420037c82c4b2bfea952cbe00730930844969438 (diff) | |
Update the README with information about how to run the QUIC demos
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
Reviewed-by: Richard Levitte <levitte@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/22552)
Diffstat (limited to 'demos')
| -rw-r--r-- | demos/guide/README.md | 28 |
1 files changed, 28 insertions, 0 deletions
diff --git a/demos/guide/README.md b/demos/guide/README.md index a412585d34..ecd2fefaaf 100644 --- a/demos/guide/README.md +++ b/demos/guide/README.md @@ -5,6 +5,9 @@ The demos in this directory are the complete source code for the applications developed in the OpenSSL Guide tutorials. Refer to the various tutorial pages in the [guide] for an extensive discussion on the demos available here. +They must be built before they can be run. An example UNIX style Makefile is +supplied. Just type "make" from this directory on a Linux/UNIX system. + Running the TLS Demos --------------------- @@ -45,5 +48,30 @@ Note that the test server certificate used here is only suitable for use on The tls-client-non-block demo can be run in exactly the same way. Just replace "tls-client-block" in the above example commands with "tls-client-non-block". +Running the QUIC Demos +---------------------- + +The QUIC demos can be run in a very similar way to the TLS demos. However, a +different server implementation will need to be used. + +The OpenSSL source distribution includes a test QUIC server implementation for +use with the demos. Note that, although this server does get built when building +OpenSSL from source, it does not get installed via "make install". After +building OpenSSL from source you will find the "quicserver" utility in the +"util" sub-directory of the top of the build tree. This server utility is not +suitable for production use and exists for test purposes only. It will be +removed from a future version of OpenSSL. + +While in the demos directory the quic server can be run like this: + +./../util/quicserver localhost 4443 servercert.pem serverkey.pem + +The QUIC demos can then be run in the same was as the TLS demos. For example +to run the quic-client-block demo: + +SSL_CERT_FILE=rootcert.pem LD_LIBRARY_PATH=../.. ./quic-client-block localhost 4443 + +<!-- Links --> + [guide]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-introduction.html [TLS Introduction]: https://www.openssl.org/docs/manmaster/man7/ossl-guide-tls-introduction.html |