Skip to content

Commit

Permalink
Update the README with information about how to run the QUIC demos
Browse files Browse the repository at this point in the history
  • Loading branch information
mattcaswell committed Oct 30, 2023
1 parent 73ebc04 commit d442046
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions demos/guide/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---------------------

Expand Down Expand Up @@ -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

0 comments on commit d442046

Please sign in to comment.