Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@ android/wolfssljni-ndk-sample/proguard-project.txt
/dtls/client-dtls-shared
/dtls/client-dtls
/dtls/client-dtls13
/dtls/client-dtls13-earlydata
/dtls/client-udp
/dtls/memory-bio-dtls
/dtls/server-dtls-callback
Expand All @@ -64,6 +65,7 @@ android/wolfssljni-ndk-sample/proguard-project.txt
/dtls/server-dtls-threaded
/dtls/server-dtls
/dtls/server-dtls13
/dtls/server-dtls13-earlydata
/dtls/server-dtls13-event
/dtls/server-udp

Expand All @@ -84,6 +86,8 @@ android/wolfssljni-ndk-sample/proguard-project.txt
/tls/client-tls
/tls/client-tls13
/tls/client-tls13-resume
/tls/client-tls13-earlydata
/tls/server-tls13-earlydata
/tls/client-tls-bio
/tls/client-tls-cacb
/tls/client-tls-callback
Expand Down
45 changes: 45 additions & 0 deletions dtls/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
- 5.2.4.1. Variables
- 5.2.4.2. Adding a Loop
- 5.2.5. Final Note
- Chapter 6: DTLS 1.3 Early Data (0-RTT) with Session Resumption
- References
## CHAPTER 1: A Simple UDP Server & Client
### Section 1: By Kaleb Himes
Expand Down Expand Up @@ -1679,6 +1680,50 @@ The code above was taken directly from the DTLS server nonblocking file.

Be sure to keep in mind that the `AwaitDatagram` code is essentially one large loop that will attempt to listen for a client (in a nonblocking fashion) at every iteration, and will close the loop upon a signal passed by the user.

## Chapter 6: DTLS 1.3 Early Data (0-RTT) with Session Resumption

This pair of examples demonstrates DTLS 1.3 early data (0-RTT) using wolfSSL.
The client performs an initial connection to obtain a session ticket, then
reconnects and sends early data during the resumed handshake. The server reads
early data and can send application data immediately (so-called 0.5-RTT), then
continues with the normal handshake/application data flow.

It is recommended to build wolfSSL with `WOLFSSL_DTLS13_NO_HRR_ON_RESUME` so the
server does not send a HelloRetryRequest (HRR) when resuming sessions. (The
server example also enables this behavior per-connection with
`wolfSSL_dtls13_no_hrr_on_resume()`.)

Files:
- `server-dtls13-earlydata.c`: DTLS 1.3 server that receives early data using
`wolfSSL_read_early_data()`. It sets a maximum early data size using
`wolfSSL_CTX_set_max_early_data()` and may send 0.5-RTT application data.
- `client-dtls13-earlydata.c`: DTLS 1.3 client that first connects to obtain a
session ticket, then reconnects and sends early data using
`wolfSSL_write_early_data()` before finishing the handshake. After the
handshake, it also sends a normal (post-handshake) application data message.

Build requirements:
- wolfSSL must be built with DTLS 1.3 and early data support enabled.
Enable early data support by building wolfSSL with
`--enable-earlydata --enable-session-ticket`.

Build and run (in `wolfssl-examples/dtls`, in separate terminals):

```sh
make clean && make
./server-dtls13-earlydata
./client-dtls13-earlydata 127.0.0.1
```

Expected behavior:
- On the first client run/connection, a full handshake completes and a session
ticket is obtained.
- On the second connection, the client sends early data immediately and then
completes the DTLS handshake.
- The server logs any received early data, may send a reply during early-data
processing, then finishes the handshake and sends a normal reply after
handshake completion.

#### 5.2.5 Final note
And that's it! The server has been made into a nonblocking server, and the client has been made into a nonblocking client.

Expand Down
218 changes: 218 additions & 0 deletions dtls/client-dtls13-earlydata.c
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
/* client-dtls13-earlydata.c
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add these to the tls/README.md and dtls/README.md

Also if wolfSSL isn't built with --enable-earlydata then you get:

gcc -o client-tls13-earlydata  client-tls13-earlydata.c -Wall -I/usr/local/include -Os -L/usr/local/lib -lm -lwolfssl
client-tls13-earlydata.c: In function ‘main’:
client-tls13-earlydata.c:131:33: warning: implicit declaration of function ‘wolfSSL_SSL_get0_session’; did you mean ‘wolfSSL_get1_session’? [-Wimplicit-function-declaration]
  131 |     if (!wolfSSL_SessionIsSetup(wolfSSL_SSL_get0_session(ssl))) {
      |                                 ^~~~~~~~~~~~~~~~~~~~~~~~
      |                                 wolfSSL_get1_session
client-tls13-earlydata.c:131:33: warning: passing argument 1 of ‘wolfSSL_SessionIsSetup’ makes pointer from integer without a cast [-Wint-conversion]
  131 |     if (!wolfSSL_SessionIsSetup(wolfSSL_SSL_get0_session(ssl))) {
      |                                 ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      |                                 |
      |                                 int
In file included from client-tls13-earlydata.c:35:
/usr/local/include/wolfssl/ssl.h:2903:57: note: expected ‘WOLFSSL_SESSION *’ but argument is of type ‘int’
 2903 | WOLFSSL_API int wolfSSL_SessionIsSetup(WOLFSSL_SESSION* session);
      |                                        ~~~~~~~~~~~~~~~~~^~~~~~~
client-tls13-earlydata.c:134:37: warning: passing argument 1 of ‘wolfSSL_SessionIsSetup’ makes pointer from integer without a cast [-Wint-conversion]
  134 |         if (!wolfSSL_SessionIsSetup(wolfSSL_SSL_get0_session(ssl))) {
      |                                     ^~~~~~~~~~~~~~~~~~~~~~~~~~~~~
      |                                     |
      |                                     int
/usr/local/include/wolfssl/ssl.h:2903:57: note: expected ‘WOLFSSL_SESSION *’ but argument is of type ‘int’
 2903 | WOLFSSL_API int wolfSSL_SessionIsSetup(WOLFSSL_SESSION* session);
      |                                        ~~~~~~~~~~~~~~~~~^~~~~~~
client-tls13-earlydata.c:181:11: warning: implicit declaration of function ‘wolfSSL_write_early_data’; did you mean ‘wolfSSL_set_ex_data’? [-Wimplicit-function-declaration]
  181 |     ret = wolfSSL_write_early_data(ssl, EARLY_DATA_MSG, EARLY_DATA_MSG_LEN, &earlyDataSent);
      |           ^~~~~~~~~~~~~~~~~~~~~~~~
      |           wolfSSL_set_ex_data
/usr/bin/ld: /tmp/cclNqs3t.o: in function `main':
client-tls13-earlydata.c:(.text.startup+0x183): undefined reference to `wolfSSL_SSL_get0_session'
/usr/bin/ld: client-tls13-earlydata.c:(.text.startup+0x1a8): undefined reference to `wolfSSL_SSL_get0_session'
/usr/bin/ld: client-tls13-earlydata.c:(.text.startup+0x2eb): undefined reference to `wolfSSL_write_early_data'
collect2: error: ld returned 1 exit status
make: *** [Makefile:110: client-tls13-earlydata] Error 1

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed and added.

*
* Copyright (C) 2006-2020 wolfSSL Inc.
*
* This file is part of wolfSSL. (formerly known as CyaSSL)
*
* wolfSSL is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* wolfSSL is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/

/* Example DTLS 1.3 client using wolfSSL early data (0-RTT) with session resumption.
* Performs an initial handshake to obtain a session ticket, then reconnects and
* sends early data using wolfSSL_write_early_data().
*/

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <arpa/inet.h>
#include <sys/socket.h>

#include <wolfssl/options.h>
#include <wolfssl/ssl.h>
#include <wolfssl/wolfio.h>

#define DEFAULT_PORT 11111
#define CERT_FILE "../certs/client-cert.pem"
#define KEY_FILE "../certs/client-key.pem"
#define CA_FILE "../certs/ca-cert.pem"

#define EARLY_DATA_MSG "Early data hello from early data DTLS client!"
#define EARLY_DATA_MSG_LEN (sizeof(EARLY_DATA_MSG))
#define DATA_MSG "Normal data hello from early data DTLS client!"
#define DATA_MSG_LEN (sizeof(DATA_MSG))

static int udp_create_socket(const char* ip, int port, struct sockaddr_in* servAddr) {
int sockfd;

if ((sockfd = socket(AF_INET, SOCK_DGRAM, 0)) < 0) {
perror("socket()");
return -1;
}

memset(servAddr, 0, sizeof(*servAddr));
servAddr->sin_family = AF_INET;
servAddr->sin_port = htons(port);

if (inet_pton(AF_INET, ip, &servAddr->sin_addr) != 1) {
perror("inet_pton()");
close(sockfd);
return -1;
}

return sockfd;
}

int main(int argc, char** argv)
{
if (argc != 2) {
printf("Usage: %s <server-ip>\n", argv[0]);
return 1;
}

const char* server_ip = argv[1];
int ret = 1;
int sockfd = -1;
WOLFSSL_CTX* ctx = NULL;
WOLFSSL* ssl = NULL;
WOLFSSL_SESSION* session = NULL;
char recvBuf[256];
int len;
int earlyDataSent = 0;
struct sockaddr_in servAddr;

/* Initialize wolfSSL */
if (wolfSSL_Init() != WOLFSSL_SUCCESS) {
fprintf(stderr, "wolfSSL_Init failed\n");
goto cleanup;
}

/* Create and configure context */
ctx = wolfSSL_CTX_new(wolfDTLSv1_3_client_method());
if (!ctx) {
fprintf(stderr, "wolfSSL_CTX_new failed\n");
goto cleanup;
}

if (wolfSSL_CTX_use_certificate_file(ctx, CERT_FILE, WOLFSSL_FILETYPE_PEM) != WOLFSSL_SUCCESS ||
wolfSSL_CTX_use_PrivateKey_file(ctx, KEY_FILE, WOLFSSL_FILETYPE_PEM) != WOLFSSL_SUCCESS ||
wolfSSL_CTX_load_verify_locations(ctx, CA_FILE, NULL) != WOLFSSL_SUCCESS) {
fprintf(stderr, "Failed to load cert/key/CA\n");
goto cleanup;
}

/* === 1st connection: perform handshake and get session ticket === */
sockfd = udp_create_socket(server_ip, DEFAULT_PORT, &servAddr);
if (sockfd < 0) goto cleanup;

ssl = wolfSSL_new(ctx);
if (!ssl) {
fprintf(stderr, "wolfSSL_new failed\n");
goto cleanup;
}
if (wolfSSL_set_fd(ssl, sockfd) != WOLFSSL_SUCCESS) {
fprintf(stderr, "wolfSSL_set_fd failed\n");
goto cleanup;
}
wolfSSL_dtls_set_peer(ssl, (struct sockaddr*)&servAddr, sizeof(servAddr));

if (wolfSSL_connect(ssl) != WOLFSSL_SUCCESS) {
fprintf(stderr, "wolfSSL_connect failed\n");
goto cleanup;
}

/* Check if ticket was received */
if (!wolfSSL_SessionIsSetup(wolfSSL_get_session(ssl))) {
(void)wolfSSL_peek(ssl, recvBuf, 0);
if (!wolfSSL_SessionIsSetup(wolfSSL_get_session(ssl))) {
fprintf(stderr, "Session ticket not received from server\n");
goto cleanup;
}
}

/* Save session for resumption */
session = wolfSSL_get1_session(ssl);
if (!session) {
fprintf(stderr, "wolfSSL_get1_session failed\n");
goto cleanup;
}

printf("Initial handshake complete, session ticket obtained.\n");

/* Clean up first connection with full shutdown */
wolfSSL_shutdown(ssl);
wolfSSL_free(ssl);
ssl = NULL;
close(sockfd);
sockfd = -1;

/* === 2nd connection: resume session and send early data === */
sockfd = udp_create_socket(server_ip, DEFAULT_PORT, &servAddr);
if (sockfd < 0) goto cleanup;

ssl = wolfSSL_new(ctx);
if (!ssl) {
fprintf(stderr, "wolfSSL_new (2nd) failed\n");
goto cleanup;
}
if (wolfSSL_set_fd(ssl, sockfd) != WOLFSSL_SUCCESS) {
fprintf(stderr, "wolfSSL_set_fd (2nd) failed\n");
goto cleanup;
}
wolfSSL_dtls_set_peer(ssl, (struct sockaddr*)&servAddr, sizeof(servAddr));

if (wolfSSL_set_session(ssl, session) != WOLFSSL_SUCCESS) {
fprintf(stderr, "wolfSSL_set_session failed\n");
goto cleanup;
}

ret = wolfSSL_write_early_data(ssl, EARLY_DATA_MSG, EARLY_DATA_MSG_LEN, &earlyDataSent);
if (ret == EARLY_DATA_MSG_LEN && earlyDataSent == EARLY_DATA_MSG_LEN) {
printf("Sent early data: \"%s\"\n", EARLY_DATA_MSG);
} else {
fprintf(stderr, "wolfSSL_write_early_data failed: ret=%d sent=%d\n", ret, earlyDataSent);
goto cleanup;
}

/* Complete handshake */
while (wolfSSL_connect(ssl) != WOLFSSL_SUCCESS) {
if (wolfSSL_get_error(ssl, -1) != APP_DATA_READY) {
fprintf(stderr, "wolfSSL_connect (2nd) failed\n");
goto cleanup;
}
else {
memset(recvBuf, 0, sizeof(recvBuf));
len = wolfSSL_read(ssl, recvBuf, sizeof(recvBuf) - 1);
if (len > 0) {
printf("Server sent during handshake: %s\n", recvBuf);
}
}
}
printf("Handshake complete after early data.\n");

if (wolfSSL_write(ssl, DATA_MSG, DATA_MSG_LEN) != DATA_MSG_LEN) {
fprintf(stderr, "wolfSSL_write (normal data) failed\n");
}
else {
printf("Sent normal data: \"%s\"\n", DATA_MSG);
}

/* Read server response */
memset(recvBuf, 0, sizeof(recvBuf));
while ((len = wolfSSL_read(ssl, recvBuf, sizeof(recvBuf) - 1)) > 0)
printf("Server replied: %s\n", recvBuf);

ret = 0; /* Success */

cleanup:
wolfSSL_shutdown(ssl);
if (ssl) wolfSSL_free(ssl);
if (session) wolfSSL_SESSION_free(session);
if (ctx) wolfSSL_CTX_free(ctx);
if (sockfd >= 0) close(sockfd);
wolfSSL_Cleanup();
return ret;
}
Loading