| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514 |
- .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
- .\"
- .\" Standard preamble:
- .\" ========================================================================
- .de Sp \" Vertical space (when we can't use .PP)
- .if t .sp .5v
- .if n .sp
- ..
- .de Vb \" Begin verbatim text
- .ft CW
- .nf
- .ne \\$1
- ..
- .de Ve \" End verbatim text
- .ft R
- .fi
- ..
- .\" Set up some character translations and predefined strings. \*(-- will
- .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
- .\" double quote, and \*(R" will give a right double quote. \*(C+ will
- .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
- .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
- .\" nothing in troff, for use with C<>.
- .tr \(*W-
- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
- .ie n \{\
- . ds -- \(*W-
- . ds PI pi
- . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
- . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
- . ds L" ""
- . ds R" ""
- . ds C` ""
- . ds C' ""
- 'br\}
- .el\{\
- . ds -- \|\(em\|
- . ds PI \(*p
- . ds L" ``
- . ds R" ''
- . ds C`
- . ds C'
- 'br\}
- .\"
- .\" Escape single quotes in literal strings from groff's Unicode transform.
- .ie \n(.g .ds Aq \(aq
- .el .ds Aq '
- .\"
- .\" If the F register is >0, we'll generate index entries on stderr for
- .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
- .\" entries marked with X<> in POD. Of course, you'll have to process the
- .\" output yourself in some meaningful fashion.
- .\"
- .\" Avoid warning from groff about undefined register 'F'.
- .de IX
- ..
- .nr rF 0
- .if \n(.g .if rF .nr rF 1
- .if (\n(rF:(\n(.g==0)) \{\
- . if \nF \{\
- . de IX
- . tm Index:\\$1\t\\n%\t"\\$2"
- ..
- . if !\nF==2 \{\
- . nr % 0
- . nr F 2
- . \}
- . \}
- .\}
- .rr rF
- .\"
- .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
- .\" Fear. Run. Save yourself. No user-serviceable parts.
- . \" fudge factors for nroff and troff
- .if n \{\
- . ds #H 0
- . ds #V .8m
- . ds #F .3m
- . ds #[ \f1
- . ds #] \fP
- .\}
- .if t \{\
- . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
- . ds #V .6m
- . ds #F 0
- . ds #[ \&
- . ds #] \&
- .\}
- . \" simple accents for nroff and troff
- .if n \{\
- . ds ' \&
- . ds ` \&
- . ds ^ \&
- . ds , \&
- . ds ~ ~
- . ds /
- .\}
- .if t \{\
- . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
- . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
- . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
- . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
- . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
- . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
- .\}
- . \" troff and (daisy-wheel) nroff accents
- .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
- .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
- .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
- .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
- .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
- .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
- .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
- .ds ae a\h'-(\w'a'u*4/10)'e
- .ds Ae A\h'-(\w'A'u*4/10)'E
- . \" corrections for vroff
- .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
- .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
- . \" for low resolution devices (crt and lpr)
- .if \n(.H>23 .if \n(.V>19 \
- \{\
- . ds : e
- . ds 8 ss
- . ds o a
- . ds d- d\h'-1'\(ga
- . ds D- D\h'-1'\(hy
- . ds th \o'bp'
- . ds Th \o'LP'
- . ds ae ae
- . ds Ae AE
- .\}
- .rm #[ #] #H #V #F C
- .\" ========================================================================
- .\"
- .IX Title "OSSL-GUIDE-QUIC-CLIENT-BLOCK 7ossl"
- .TH OSSL-GUIDE-QUIC-CLIENT-BLOCK 7ossl "2024-09-03" "3.3.2" "OpenSSL"
- .\" For nroff, turn off justification. Always turn off hyphenation; it makes
- .\" way too many mistakes in technical documents.
- .if n .ad l
- .nh
- .SH "NAME"
- ossl\-guide\-quic\-client\-block
- \&\- OpenSSL Guide: Writing a simple blocking QUIC client
- .SH "SIMPLE BLOCKING QUIC CLIENT EXAMPLE"
- .IX Header "SIMPLE BLOCKING QUIC CLIENT EXAMPLE"
- This page will present various source code samples demonstrating how to write
- a simple blocking \s-1QUIC\s0 client application which connects to a server, sends an
- \&\s-1HTTP/1.0\s0 request to it, and reads back the response. Note that \s-1HTTP/1.0\s0 over
- \&\s-1QUIC\s0 is non-standard and will not be supported by real world servers. This is
- for demonstration purposes only.
- .PP
- We assume that you already have OpenSSL installed on your system; that you
- already have some fundamental understanding of OpenSSL concepts, \s-1TLS\s0 and \s-1QUIC\s0
- (see \fBossl\-guide\-libraries\-introduction\fR\|(7), \fBossl\-guide\-tls\-introduction\fR\|(7)
- and \fBossl\-guide\-quic\-introduction\fR\|(7)); and that you know how to
- write and build C code and link it against the libcrypto and libssl libraries
- that are provided by OpenSSL. It also assumes that you have a basic
- understanding of \s-1UDP/IP\s0 and sockets. The example code that we build in this
- tutorial will amend the blocking \s-1TLS\s0 client example that is covered in
- \&\fBossl\-guide\-tls\-client\-block\fR\|(7). Only the differences between that client and
- this one will be discussed so we also assume that you have run through and
- understand that tutorial.
- .PP
- For this tutorial our client will be using a single \s-1QUIC\s0 stream. A subsequent
- tutorial will discuss how to write a multi-stream client (see
- \&\fBossl\-guide\-quic\-multi\-stream\fR\|(7)).
- .PP
- The complete source code for this example blocking \s-1QUIC\s0 client is available in
- the \f(CW\*(C`demos/guide\*(C'\fR directory of the OpenSSL source distribution in the file
- \&\f(CW\*(C`quic\-client\-block.c\*(C'\fR. It is also available online at
- <https://github.com/openssl/openssl/blob/master/demos/guide/quic\-client\-block.c>.
- .SS "Creating the \s-1SSL_CTX\s0 and \s-1SSL\s0 objects"
- .IX Subsection "Creating the SSL_CTX and SSL objects"
- In the \s-1TLS\s0 tutorial (\fBossl\-guide\-tls\-client\-block\fR\|(7)) we created an \fB\s-1SSL_CTX\s0\fR
- object for our client and used it to create an \fB\s-1SSL\s0\fR object to represent the
- \&\s-1TLS\s0 connection. A \s-1QUIC\s0 connection works in exactly the same way. We first create
- an \fB\s-1SSL_CTX\s0\fR object and then use it to create an \fB\s-1SSL\s0\fR object to represent the
- \&\s-1QUIC\s0 connection.
- .PP
- As in the \s-1TLS\s0 example the first step is to create an \fB\s-1SSL_CTX\s0\fR object for our
- client. This is done in the same way as before except that we use a different
- \&\*(L"method\*(R". OpenSSL offers two different \s-1QUIC\s0 client methods, i.e.
- \&\fBOSSL_QUIC_client_method\fR\|(3) and \fBOSSL_QUIC_client_thread_method\fR\|(3).
- .PP
- The first one is the equivalent of \fBTLS_client_method\fR\|(3) but for the \s-1QUIC\s0
- protocol. The second one is the same, but it will additionally create a
- background thread for handling time based events (known as \*(L"thread assisted
- mode\*(R", see \fBossl\-guide\-quic\-introduction\fR\|(7)). For this tutorial we will be
- using \fBOSSL_QUIC_client_method\fR\|(3) because we will not be leaving the \s-1QUIC\s0
- connection idle in our application and so thread assisted mode is not needed.
- .PP
- .Vb 10
- \& /*
- \& * Create an SSL_CTX which we can use to create SSL objects from. We
- \& * want an SSL_CTX for creating clients so we use OSSL_QUIC_client_method()
- \& * here.
- \& */
- \& ctx = SSL_CTX_new(OSSL_QUIC_client_method());
- \& if (ctx == NULL) {
- \& printf("Failed to create the SSL_CTX\en");
- \& goto end;
- \& }
- .Ve
- .PP
- The other setup steps that we applied to the \fB\s-1SSL_CTX\s0\fR for \s-1TLS\s0 also apply to
- \&\s-1QUIC\s0 except for restricting the \s-1TLS\s0 versions that we are willing to accept. The
- \&\s-1QUIC\s0 protocol implementation in OpenSSL currently only supports TLSv1.3. There
- is no need to call \fBSSL_CTX_set_min_proto_version\fR\|(3) or
- \&\fBSSL_CTX_set_max_proto_version\fR\|(3) in an OpenSSL \s-1QUIC\s0 application, and any such
- call will be ignored.
- .PP
- Once the \fB\s-1SSL_CTX\s0\fR is created, the \fB\s-1SSL\s0\fR object is constructed in exactly the
- same way as for the \s-1TLS\s0 application.
- .SS "Creating the socket and \s-1BIO\s0"
- .IX Subsection "Creating the socket and BIO"
- A major difference between \s-1TLS\s0 and \s-1QUIC\s0 is the underlying transport protocol.
- \&\s-1TLS\s0 uses \s-1TCP\s0 while \s-1QUIC\s0 uses \s-1UDP.\s0 The way that the \s-1QUIC\s0 socket is created in our
- example code is much the same as for \s-1TLS.\s0 We use the \fBBIO_lookup_ex\fR\|(3) and
- \&\fBBIO_socket\fR\|(3) helper functions as we did in the previous tutorial except that
- we pass \fB\s-1SOCK_DGRAM\s0\fR as an argument to indicate \s-1UDP\s0 (instead of \fB\s-1SOCK_STREAM\s0\fR
- for \s-1TCP\s0).
- .PP
- .Vb 6
- \& /*
- \& * Lookup IP address info for the server.
- \& */
- \& if (!BIO_lookup_ex(hostname, port, BIO_LOOKUP_CLIENT, family, SOCK_DGRAM, 0,
- \& &res))
- \& return NULL;
- \&
- \& /*
- \& * Loop through all the possible addresses for the server and find one
- \& * we can connect to.
- \& */
- \& for (ai = res; ai != NULL; ai = BIO_ADDRINFO_next(ai)) {
- \& /*
- \& * Create a TCP socket. We could equally use non\-OpenSSL calls such
- \& * as "socket" here for this and the subsequent connect and close
- \& * functions. But for portability reasons and also so that we get
- \& * errors on the OpenSSL stack in the event of a failure we use
- \& * OpenSSL\*(Aqs versions of these functions.
- \& */
- \& sock = BIO_socket(BIO_ADDRINFO_family(ai), SOCK_DGRAM, 0, 0);
- \& if (sock == \-1)
- \& continue;
- \&
- \& /* Connect the socket to the server\*(Aqs address */
- \& if (!BIO_connect(sock, BIO_ADDRINFO_address(ai), 0)) {
- \& BIO_closesocket(sock);
- \& sock = \-1;
- \& continue;
- \& }
- \&
- \& /* Set to nonblocking mode */
- \& if (!BIO_socket_nbio(sock, 1)) {
- \& BIO_closesocket(sock);
- \& sock = \-1;
- \& continue;
- \& }
- \&
- \& break;
- \& }
- \&
- \& if (sock != \-1) {
- \& *peer_addr = BIO_ADDR_dup(BIO_ADDRINFO_address(ai));
- \& if (*peer_addr == NULL) {
- \& BIO_closesocket(sock);
- \& return NULL;
- \& }
- \& }
- \&
- \& /* Free the address information resources we allocated earlier */
- \& BIO_ADDRINFO_free(res);
- .Ve
- .PP
- You may notice a couple of other differences between this code and the version
- that we used for \s-1TLS.\s0
- .PP
- Firstly, we set the socket into nonblocking mode. This must always be done for
- an OpenSSL \s-1QUIC\s0 application. This may be surprising considering that we are
- trying to write a blocking client. Despite this the \fB\s-1SSL\s0\fR object will still
- have blocking behaviour. See \fBossl\-guide\-quic\-introduction\fR\|(7) for further
- information on this.
- .PP
- Secondly, we take note of the \s-1IP\s0 address of the peer that we are connecting to.
- We store that information away. We will need it later.
- .PP
- See \fBBIO_lookup_ex\fR\|(3), \fBBIO_socket\fR\|(3), \fBBIO_connect\fR\|(3),
- \&\fBBIO_closesocket\fR\|(3), \fBBIO_ADDRINFO_next\fR\|(3), \fBBIO_ADDRINFO_address\fR\|(3),
- \&\fBBIO_ADDRINFO_free\fR\|(3) and \fBBIO_ADDR_dup\fR\|(3) for further information on the
- functions used here. In the above example code the \fBhostname\fR and \fBport\fR
- variables are strings, e.g. \*(L"www.example.com\*(R" and \*(L"443\*(R".
- .PP
- As for our \s-1TLS\s0 client, once the socket has been created and connected we need to
- associate it with a \s-1BIO\s0 object:
- .PP
- .Vb 1
- \& BIO *bio;
- \&
- \& /* Create a BIO to wrap the socket */
- \& bio = BIO_new(BIO_s_datagram());
- \& if (bio == NULL) {
- \& BIO_closesocket(sock);
- \& return NULL;
- \& }
- \&
- \& /*
- \& * Associate the newly created BIO with the underlying socket. By
- \& * passing BIO_CLOSE here the socket will be automatically closed when
- \& * the BIO is freed. Alternatively you can use BIO_NOCLOSE, in which
- \& * case you must close the socket explicitly when it is no longer
- \& * needed.
- \& */
- \& BIO_set_fd(bio, sock, BIO_CLOSE);
- .Ve
- .PP
- Note the use of \fBBIO_s_datagram\fR\|(3) here as opposed to \fBBIO_s_socket\fR\|(3) that
- we used for our \s-1TLS\s0 client. This is again due to the fact that \s-1QUIC\s0 uses \s-1UDP\s0
- instead of \s-1TCP\s0 for its transport layer. See \fBBIO_new\fR\|(3), \fBBIO_s_datagram\fR\|(3)
- and \fBBIO_set_fd\fR\|(3) for further information on these functions.
- .SS "Setting the server's hostname"
- .IX Subsection "Setting the server's hostname"
- As in the \s-1TLS\s0 tutorial we need to set the server's hostname both for \s-1SNI\s0 (Server
- Name Indication) and for certificate validation purposes. The steps for this are
- identical to the \s-1TLS\s0 tutorial and won't be repeated here.
- .SS "Setting the \s-1ALPN\s0"
- .IX Subsection "Setting the ALPN"
- \&\s-1ALPN\s0 (Application-Layer Protocol Negotiation) is a feature of \s-1TLS\s0 that enables
- the application to negotiate which protocol will be used over the connection.
- For example, if you intend to use \s-1HTTP/3\s0 over the connection then the \s-1ALPN\s0 value
- for that is \*(L"h3\*(R" (see
- <https://www.iana.org/assignments/tls\-extensiontype\-values/tls\-extensiontype\-values.xml#alpn\-protocol\-ids>).
- OpenSSL provides the ability for a client to specify the \s-1ALPN\s0 to use via the
- \&\fBSSL_set_alpn_protos\fR\|(3) function. This is optional for a \s-1TLS\s0 client and so our
- simple client that we developed in \fBossl\-guide\-tls\-client\-block\fR\|(7) did not use
- it. However \s-1QUIC\s0 mandates that the \s-1TLS\s0 handshake used in establishing a \s-1QUIC\s0
- connection must use \s-1ALPN.\s0
- .PP
- .Vb 1
- \& unsigned char alpn[] = { 8, \*(Aqh\*(Aq, \*(Aqt\*(Aq, \*(Aqt\*(Aq, \*(Aqp\*(Aq, \*(Aq/\*(Aq, \*(Aq1\*(Aq, \*(Aq.\*(Aq, \*(Aq0\*(Aq };
- \&
- \& /* SSL_set_alpn_protos returns 0 for success! */
- \& if (SSL_set_alpn_protos(ssl, alpn, sizeof(alpn)) != 0) {
- \& printf("Failed to set the ALPN for the connection\en");
- \& goto end;
- \& }
- .Ve
- .PP
- The \s-1ALPN\s0 is specified using a length prefixed array of unsigned chars (it is not
- a \s-1NUL\s0 terminated string). Our original \s-1TLS\s0 blocking client demo was using
- \&\s-1HTTP/1.0.\s0 We will use the same for this example. Unlike most OpenSSL functions
- \&\fBSSL_set_alpn_protos\fR\|(3) returns zero for success and nonzero for failure.
- .SS "Setting the peer address"
- .IX Subsection "Setting the peer address"
- An OpenSSL \s-1QUIC\s0 application must specify the target address of the server that
- is being connected to. In \*(L"Creating the socket and \s-1BIO\*(R"\s0 above we saved that
- address away for future use. Now we need to use it via the
- \&\fBSSL_set1_initial_peer_addr\fR\|(3) function.
- .PP
- .Vb 5
- \& /* Set the IP address of the remote peer */
- \& if (!SSL_set1_initial_peer_addr(ssl, peer_addr)) {
- \& printf("Failed to set the initial peer address\en");
- \& goto end;
- \& }
- .Ve
- .PP
- Note that we will need to free the \fBpeer_addr\fR value that we allocated via
- \&\fBBIO_ADDR_dup\fR\|(3) earlier:
- .PP
- .Vb 1
- \& BIO_ADDR_free(peer_addr);
- .Ve
- .SS "The handshake and application data transfer"
- .IX Subsection "The handshake and application data transfer"
- Once initial setup of the \fB\s-1SSL\s0\fR object is complete then we perform the
- handshake via \fBSSL_connect\fR\|(3) in exactly the same way as we did for the \s-1TLS\s0
- client, so we won't repeat it here.
- .PP
- We can also perform data transfer using a default \s-1QUIC\s0 stream that is
- automatically associated with the \fB\s-1SSL\s0\fR object for us. We can transmit data
- using \fBSSL_write_ex\fR\|(3), and receive data using \fBSSL_read_ex\fR\|(3) in the same
- way as for \s-1TLS.\s0 The main difference is that we have to account for failures
- slightly differently. With \s-1QUIC\s0 the stream can be reset by the peer (which is
- fatal for that stream), but the underlying connection itself may still be
- healthy.
- .PP
- .Vb 10
- \& /*
- \& * Get up to sizeof(buf) bytes of the response. We keep reading until the
- \& * server closes the connection.
- \& */
- \& while (SSL_read_ex(ssl, buf, sizeof(buf), &readbytes)) {
- \& /*
- \& * OpenSSL does not guarantee that the returned data is a string or
- \& * that it is NUL terminated so we use fwrite() to write the exact
- \& * number of bytes that we read. The data could be non\-printable or
- \& * have NUL characters in the middle of it. For this simple example
- \& * we\*(Aqre going to print it to stdout anyway.
- \& */
- \& fwrite(buf, 1, readbytes, stdout);
- \& }
- \& /* In case the response didn\*(Aqt finish with a newline we add one now */
- \& printf("\en");
- \&
- \& /*
- \& * Check whether we finished the while loop above normally or as the
- \& * result of an error. The 0 argument to SSL_get_error() is the return
- \& * code we received from the SSL_read_ex() call. It must be 0 in order
- \& * to get here. Normal completion is indicated by SSL_ERROR_ZERO_RETURN. In
- \& * QUIC terms this means that the peer has sent FIN on the stream to
- \& * indicate that no further data will be sent.
- \& */
- \& switch (SSL_get_error(ssl, 0)) {
- \& case SSL_ERROR_ZERO_RETURN:
- \& /* Normal completion of the stream */
- \& break;
- \&
- \& case SSL_ERROR_SSL:
- \& /*
- \& * Some stream fatal error occurred. This could be because of a stream
- \& * reset \- or some failure occurred on the underlying connection.
- \& */
- \& switch (SSL_get_stream_read_state(ssl)) {
- \& case SSL_STREAM_STATE_RESET_REMOTE:
- \& printf("Stream reset occurred\en");
- \& /* The stream has been reset but the connection is still healthy. */
- \& break;
- \&
- \& case SSL_STREAM_STATE_CONN_CLOSED:
- \& printf("Connection closed\en");
- \& /* Connection is already closed. Skip SSL_shutdown() */
- \& goto end;
- \&
- \& default:
- \& printf("Unknown stream failure\en");
- \& break;
- \& }
- \& break;
- \&
- \& default:
- \& /* Some other unexpected error occurred */
- \& printf ("Failed reading remaining data\en");
- \& break;
- \& }
- .Ve
- .PP
- In the above code example you can see that \fB\s-1SSL_ERROR_SSL\s0\fR indicates a stream
- fatal error. We can use \fBSSL_get_stream_read_state\fR\|(3) to determine whether the
- stream has been reset, or if some other fatal error has occurred.
- .SS "Shutting down the connection"
- .IX Subsection "Shutting down the connection"
- In the \s-1TLS\s0 tutorial we knew that the server had finished sending data because
- \&\fBSSL_read_ex\fR\|(3) returned 0, and \fBSSL_get_error\fR\|(3) returned
- \&\fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR. The same is true with \s-1QUIC\s0 except that
- \&\fB\s-1SSL_ERROR_ZERO_RETURN\s0\fR should be interpreted slightly differently. With \s-1TLS\s0
- we knew that this meant that the server had sent a \*(L"close_notify\*(R" alert. No
- more data will be sent from the server on that connection.
- .PP
- With \s-1QUIC\s0 it means that the server has indicated \*(L"\s-1FIN\*(R"\s0 on the stream, meaning
- that it will no longer send any more data on that stream. However this only
- gives us information about the stream itself and does not tell us anything about
- the underlying connection. More data could still be sent from the server on some
- other stream. Additionally, although the server will not send any more data to
- the client, it does not prevent the client from sending more data to the server.
- .PP
- In this tutorial, once we have finished reading data from the server on the one
- stream that we are using, we will close the connection down. As before we do
- this via the \fBSSL_shutdown\fR\|(3) function. This example for \s-1QUIC\s0 is very similar
- to the \s-1TLS\s0 version. However the \fBSSL_shutdown\fR\|(3) function will need to be
- called more than once:
- .PP
- .Vb 11
- \& /*
- \& * Repeatedly call SSL_shutdown() until the connection is fully
- \& * closed.
- \& */
- \& do {
- \& ret = SSL_shutdown(ssl);
- \& if (ret < 0) {
- \& printf("Error shutting down: %d\en", ret);
- \& goto end;
- \& }
- \& } while (ret != 1);
- .Ve
- .PP
- The shutdown process is in two stages. In the first stage we wait until all the
- data we have buffered for sending on any stream has been successfully sent and
- acknowledged by the peer, and then we send a \s-1CONNECTION_CLOSE\s0 to the peer to
- indicate that the connection is no longer usable. This immediately closes the
- connection and no more data can be sent or received. \fBSSL_shutdown\fR\|(3) returns
- 0 once the first stage has been completed.
- .PP
- In the second stage the connection enters a \*(L"closing\*(R" state. Application data
- cannot be sent or received in this state, but late arriving packets coming from
- the peer will be handled appropriately. Once this stage has completed
- successfully \fBSSL_shutdown\fR\|(3) will return 1 to indicate success.
- .SH "FURTHER READING"
- .IX Header "FURTHER READING"
- See \fBossl\-guide\-quic\-multi\-stream\fR\|(7) to read a tutorial on how to modify the
- client developed on this page to support multiple streams.
- .SH "SEE ALSO"
- .IX Header "SEE ALSO"
- \&\fBossl\-guide\-introduction\fR\|(7), \fBossl\-guide\-libraries\-introduction\fR\|(7),
- \&\fBossl\-guide\-libssl\-introduction\fR\|(7), \fBossl\-guide\-tls\-introduction\fR\|(7),
- \&\fBossl\-guide\-tls\-client\-block\fR\|(7), \fBossl\-guide\-quic\-introduction\fR\|(7)
- .SH "COPYRIGHT"
- .IX Header "COPYRIGHT"
- Copyright 2023 The OpenSSL Project Authors. All Rights Reserved.
- .PP
- Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use
- this file except in compliance with the License. You can obtain a copy
- in the file \s-1LICENSE\s0 in the source distribution or at
- <https://www.openssl.org/source/license.html>.
|