ESP32 WiFiClientSecure Library – readBytes

Home / References / ESP32 Library / WiFiClientSecure

Description

The readBytes method in the WiFiClientSecure library is used to read a specified number of bytes from a secure network stream into a buffer. This method is particularly useful when retrieving data from a secure server (e.g., via HTTPS) connected through a WiFiClientSecure object. It blocks until the requested number of bytes is read or the connection is closed, making it ideal for applications requiring precise data retrieval over a TLS/SSL connection.


Syntax and Usage

The readBytes method can be used in a single way, requiring specific arguments to function correctly. Below is the syntax and usage:

size_t readBytes(uint8_t *buffer, size_t length);
  • Reading a specified number of bytes: This method reads up to length bytes from the secure stream and stores them in the provided buffer. It returns the number of bytes actually read, which may be less than requested if the stream ends or an error occurs.

Note: Unlike some other methods, readBytes does not have an argument-free variant in the WiFiClientSecure library. It always requires a buffer and length to operate.

For practical applications and examples of this method, please consult the “Example Code” section on this page. This section provides comprehensive guidance to help you better understand and apply the method effectively.


Argument(s)

The readBytes method requires the following arguments:

  • uint8_t *buffer: A pointer to an array where the read bytes will be stored. This buffer must be pre-allocated with sufficient space to hold the requested number of bytes.
  • size_t length: The number of bytes to read from the stream. This specifies the maximum amount of data to retrieve in a single call.

Return Value

The readBytes method returns a size_t value representing the number of bytes actually read into the buffer. This value may be less than the requested length if the stream ends before all bytes are read or if an error occurs. A return value of 0 indicates that no data was available or the connection was closed.


Example Codes

Below is an example demonstrating the use of the readBytes method in a practical scenario. This corresponds to the usage described in Section 2.

Example: Reading Data from a Secure HTTPS Server

This example connects to a secure server (e.g., “www.httpbin.org” over HTTPS), sends a POST request, and uses readBytes to read the response into a buffer. The retrieved data is then printed to the Serial Monitor. Ensure you replace the Wi-Fi credentials and certificate with your own.

ATTENTION: The Root CA certificate has an expiration date. If the code fails to execute, it may be due to the Root CA certificate has expired. Try obtaining the latest Root CA certificate and replacing the expired one in this code. For detailed instructions on acquiring a website’s Root CA certificate, check out the link below:
How to Acquire the Root CA Certificate

/*
 * Author: Avant Maker
 * Date: February 24, 2025
 * Version: 1.0
 *
 * Description: This example demostrate how to use 
 * ESP32 WiFiClientSecure Libary's 
 * readBytes method to read the response into
 * a buffer. The retrieved data is then printed
 * to the Serial Monitor.  
 * 
 * ATTENTION: The Root CA certificate has an expiration date. 
 * If the code fails to execute, it may be due to the Root CA
 * certificate has expired. Try obtaining the latest 
 * Root CA certificate and replacing the expired one in this code.
 * For detailed instructions on acquiring a website's
 * Root CA certificate, check out the link below:
 *
 * https://avantmaker.com/references/esp32-arduino-core-index/esp32-wificlientsecure-library/how-to-acquire-the-root-ca-certificate/
 *
 * License: MIT 
 * 
 * Code Source: This example code is sourced from the Comprehensive 
 * Guide to the ESP32 Arduino Core Library, accessible on 
 * AvantMaker.com. For additional code examples and in-depth 
 * documentation related to the ESP32 Arduino Core Library, 
 * please visit:
 *
 * https://avantmaker.com/references/esp32-arduino-core-index/
 *
 * AvantMaker.com, your premier destination for all things 
 * DIY, AI, IoT, Smart Home, and STEM projects. We are dedicated 
 * to empowering makers, learners, and enthusiasts with the resources
 * they need to bring their innovative ideas to life.
 */

#include <WiFi.h>
#include <NetworkClientSecure.h>

const char* ssid = "your-SSID";          // Replace with your Wi-Fi SSID
const char* password = "your-PASSWORD"; // Replace with your Wi-Fi password
const char* host = "www.httpbin.org";
const int port = 443;

// Root CA certificate for www.httpbin.org (update with your server's CA if different)
const char* rootCACert = R"literal(
-----BEGIN CERTIFICATE-----
MIIEXjCCA0agAwIBAgITB3MSSkvL1E7HtTvq8ZSELToPoTANBgkqhkiG9w0BAQsF
ADA5MQswCQYDVQQGEwJVUzEPMA0GA1UEChMGQW1hem9uMRkwFwYDVQQDExBBbWF6
b24gUm9vdCBDQSAxMB4XDTIyMDgyMzIyMjUzMFoXDTMwMDgyMzIyMjUzMFowPDEL
MAkGA1UEBhMCVVMxDzANBgNVBAoTBkFtYXpvbjEcMBoGA1UEAxMTQW1hem9uIFJT
QSAyMDQ4IE0wMjCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBALtDGMZa
qHneKei1by6+pUPPLljTB143Si6VpEWPc6mSkFhZb/6qrkZyoHlQLbDYnI2D7hD0
sdzEqfnuAjIsuXQLG3A8TvX6V3oFNBFVe8NlLJHvBseKY88saLwufxkZVwk74g4n
WlNMXzla9Y5F3wwRHwMVH443xGz6UtGSZSqQ94eFx5X7Tlqt8whi8qCaKdZ5rNak
+r9nUThOeClqFd4oXych//Rc7Y0eX1KNWHYSI1Nk31mYgiK3JvH063g+K9tHA63Z
eTgKgndlh+WI+zv7i44HepRZjA1FYwYZ9Vv/9UkC5Yz8/yU65fgjaE+wVHM4e/Yy
C2osrPWE7gJ+dXMCAwEAAaOCAVowggFWMBIGA1UdEwEB/wQIMAYBAf8CAQAwDgYD
VR0PAQH/BAQDAgGGMB0GA1UdJQQWMBQGCCsGAQUFBwMBBggrBgEFBQcDAjAdBgNV
HQ4EFgQUwDFSzVpQw4J8dHHOy+mc+XrrguIwHwYDVR0jBBgwFoAUhBjMhTTsvAyU
lC4IWZzHshBOCggwewYIKwYBBQUHAQEEbzBtMC8GCCsGAQUFBzABhiNodHRwOi8v
b2NzcC5yb290Y2ExLmFtYXpvbnRydXN0LmNvbTA6BggrBgEFBQcwAoYuaHR0cDov
L2NydC5yb290Y2ExLmFtYXpvbnRydXN0LmNvbS9yb290Y2ExLmNlcjA/BgNVHR8E
ODA2MDSgMqAwhi5odHRwOi8vY3JsLnJvb3RjYTEuYW1hem9udHJ1c3QuY29tL3Jv
b3RjYTEuY3JsMBMGA1UdIAQMMAowCAYGZ4EMAQIBMA0GCSqGSIb3DQEBCwUAA4IB
AQAtTi6Fs0Azfi+iwm7jrz+CSxHH+uHl7Law3MQSXVtR8RV53PtR6r/6gNpqlzdo
Zq4FKbADi1v9Bun8RY8D51uedRfjsbeodizeBB8nXmeyD33Ep7VATj4ozcd31YFV
fgRhvTSxNrrTlNpWkUk0m3BMPv8sg381HhA6uEYokE5q9uws/3YkKqRiEz3TsaWm
JqIRZhMbgAfp7O7FUwFIb7UIspogZSKxPIWJpxiPo3TcBambbVtQOcNRWz5qCQdD
slI2yayq0n2TXoHyNCLEH8rpsJRVILFsg0jc7BaFrMnF462+ajSehgj12IidNeRN
4zl+EoNaWdpnWndvSpAEkq2P
-----END CERTIFICATE-----
)literal";

// Optional: Add client certificate and key for mutual TLS if needed
// const char* clientCertKey = "";
// const char* clientCert = "";

NetworkClientSecure secureClient;

void setup() {
    Serial.begin(115200);
    
    // Connect WiFi
    WiFi.begin(ssid, password);
    while (WiFi.status() != WL_CONNECTED) {
        delay(500);
        Serial.print(".");
    }
    Serial.println("Connected to WiFi");

    // Set the Root CA Cert
    secureClient.setCACert(rootCACert);

    // Establish secure connection to server
    if (secureClient.connect(host, port)) {
        Serial.println("Connected to server");

        // Create the POST data
        String postData = "AvantMaker=HelloFromESP32";

        // Send the POST request
        secureClient.print("POST /post HTTP/1.1\r\n");
        secureClient.print("Host: www.httpbin.org\r\n");
        secureClient.print("Content-Type: application/x-www-form-urlencoded\r\n");
        secureClient.print("Content-Length: ");
        secureClient.print(postData.length());
        secureClient.print("\r\nConnection: close\r\n\r\n");
        secureClient.print(postData);

        // Wait for server response
        while (secureClient.connected() && !secureClient.available()) {
            delay(10);
        }

        // Buffer to store response
        uint8_t buffer[512];
        size_t bytesRead;

        // Read response into buffer
        if (secureClient.available()) {
            bytesRead = secureClient.readBytes(buffer, sizeof(buffer));
            Serial.print("Bytes read: ");
            Serial.println(bytesRead);

            // Print the response
            for (size_t i = 0; i < bytesRead; i++) {
                Serial.write(buffer[i]);
            }
        } else {
            Serial.println("No data available");
        }

        secureClient.stop();

    } else {
        Serial.println("Failed to connect to server! Check the code description for solution.");
        return;
    }     
}

void loop() {
}

Explanation: In this code, the ESP32 connects to a Wi-Fi network and establishes a secure connection to www.httpbin.org” using WiFiClientSecure. After sending an HTTP POST request, readBytes reads up to 512 bytes of the server’s response into the buffer. The number of bytes read is stored in bytesRead, and the data is printed to the Serial Monitor. This demonstrates a typical use case for retrieving secure web content.

ESP32 Library Index

ESP32 Arduino Core Library


FAQ

Ready to experiment and explore more about ESP32? Visit our website’s All About ESP32 Resources Hub, packed with tutorials, guides, and tools to inspire your maker journey. Experiment, explore, and elevate your skills with everything you need to master this powerful microcontroller platform!

error: Content is protected !!