Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

NetworkClientSecure - copyability improvements and _timeout shadowing fixed #9632

Merged
merged 1 commit into from
May 15, 2024
Merged

NetworkClientSecure - copyability improvements and _timeout shadowing fixed #9632

merged 1 commit into from
May 15, 2024

Conversation

JAndrassy
Copy link
Contributor

The PR has 3 fixes for NetworkClientSecure

  1. buffer to store the peeked byte is moved into the shared objects to be shared between NetworkClientSecure copies
  2. last error code is moved into the shared objects to be available in all copies
  3. NetworkClientSecure::_timeout shadowed NetworkClient::_timeout and then NetworkClient::setConnectionTimeout didn't set the timeout for NetworkClientSecure

test (to test the last error change port to 80)

#include <WiFi.h>
#include <WiFiClientSecure.h>

const char *ssid = "yourssid";
const char *password = "yourpasswd";

const char* server = "example.com";

WiFiClientSecure connect() {
  WiFiClientSecure client;
  client.setInsecure();
  Serial.println("Starting connection to server...");
  if (client.connect(server, 443)) {
    Serial.println("connected to server");
    client.println("GET / HTTP/1.1");
    client.print("Host: ");
    client.println(server);
    client.println();
    client.find("\r\n\r\n"); // skip headers
  }
  return client;
}

char peekTest(WiFiClientSecure client) {
  return client.peek();
}

void setup() {
  Serial.begin(115200);
  while (!Serial);

  Serial.println("Waiting for connection to WiFi");
  WiFi.begin(ssid, password);
  while (WiFi.status() != WL_CONNECTED) {
    delay(1000);
    Serial.print('.');
  }
  Serial.println();
  Serial.println("Connected to WiFi network.");

  WiFiClientSecure client = connect();
  if (client) {

  char peek = peekTest(client);
  if (client.peek() != peek) {
      Serial.println("ERROR peek result doesn't match!");
      Serial.print("peek 1: ");
      Serial.println(peek);
      Serial.print("peek 2: ");
      Serial.println((char) client.peek());
      Serial.println();
    }

    while (client.available()) {
      char c = client.read();
      Serial.write(c);
    }
  } else {

    char buff[100];
    int errCode = client.lastError(buff, sizeof(buff));
    Serial.println();
    Serial.print("Connect result code: ");
    Serial.println(errCode);
    if (errCode < 0) {
      Serial.print("\tmessage: ");
      Serial.println(buff);
    }
  }
}

void loop() {
  delay(1);
}

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented May 14, 2024 •
edited
Loading

Messages
📖 🎉 Good Job! All checks are passing!

👋 Hello JAndrassy, we appreciate your contribution to this project!

Click to see more instructions ...


This automated output is generated by the PR linter DangerJS, which checks if your Pull Request meets the project's requirements and helps you fix potential issues.

DangerJS is triggered with each push event to a Pull Request and modify the contents of this comment.

Please consider the following:
- Danger mainly focuses on the PR structure and formatting and can't understand the meaning behind your code or changes.
- Danger is not a substitute for human code reviews; it's still important to request a code review from your colleagues.
- To manually retry these Danger checks, please navigate to the Actions tab and re-run last Danger workflow.

Review and merge process you can expect ...


We do welcome contributions in the form of bug reports, feature requests and pull requests.

1. An internal issue has been created for the PR, we assign it to the relevant engineer.
2. They review the PR and either approve it or ask you for changes or clarifications.
3. Once the GitHub PR is approved we do the final review, collect approvals from core owners and make sure all the automated tests are passing.
- At this point we may do some adjustments to the proposed change, or extend it by adding tests or documentation.
4. If the change is approved and passes the tests it is merged into the default branch.

Generated by 🚫 dangerJS against da152b5

@me-no-dev
Copy link
Member

Hi @JAndrassy :) This PR is failing CI. Please fix it and make sure that you add all you might need as breaking changes. Further such PRs will not be accepted until we get to next major version.

@JAndrassy
Copy link
Contributor Author

JAndrassy commented May 15, 2024 •
edited
Loading

this PR is my last for 3.0.0. I don't consider it a breaking change.

the problem with PR checks is with existing code, not with my change: and I don't know how to fix it the right way.

error: 'void* memset(void*, int, size_t)' clearing an object of non-trivial type 'sslclient_context'

C:\Users\runneradmin\Documents\Arduino\hardware\espressif\esp32\libraries\NetworkClientSecure\src\ssl_client.cpp:374:9: error: 'void* memset(void*, int, size_t)' clearing an object of non-trivial type 'sslclient_context' {aka 'struct sslclient_context'}; use assignment or value-initialization instead [-Werror=class-memaccess]
  374 |   memset(ssl_client, 0, sizeof(sslclient_context));
      |   ~~~~~~^~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
C:\Users\runneradmin\Documents\Arduino\hardware\espressif\esp32\libraries\NetworkClientSecure\src\ssl_client.h:15:16: note: 'sslclient_context' {aka 'struct sslclient_context'} declared here
   15 | typedef struct sslclient_context {
      |                ^~~~~~~~~~~~~~~~~
cc1plus.exe: some warnings being treated as errors

me-no-dev
me-no-dev reviewed May 15, 2024
View reviewed changes
libraries/NetworkClientSecure/src/ssl_client.h Outdated
@@ -26,6 +26,10 @@ typedef struct sslclient_context {

unsigned long socket_timeout;
unsigned long handshake_timeout;

int last_error = 0;
int peek_buf = -1;
Copy link
Member

Choose a reason for hiding this comment

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

you are setting here default value -1 and the code calls memset(ssl_client, 0, sizeof(sslclient_context)); which would set it to 0. That is why you are getting the error. Do not add default value like that and make sure that when cleared it is then set properly.

@JAndrassy
Copy link
Contributor Author

so the default values made the struct "non-trivial". thank you

@me-no-dev me-no-dev added the Status: Pending Merge Pull Request is ready to be merged label May 15, 2024
@github-actions GitHub Actions
Copy link
Contributor

Memory usage test (comparing PR against master branch)

The table below shows the summary of memory usage change (decrease - increase) in bytes and percentage for each target.

MemoryFLASH [bytes]FLASH [%]RAM [bytes]RAM [%]
TargetDECINCDECINCDECINCDECINC
ESP32S30⚠️ +440.000.00💚 -160💚 -0.040.00
ESP32S20⚠️ +560.00⚠️ +0.01💚 -160💚 -0.050.00
ESP32C30⚠️ +940.00⚠️ +0.01💚 -160💚 -0.050.00
ESP32C60⚠️ +940.00⚠️ +0.01💚 -160💚 -0.040.00
ESP32H2000.000.00000.000.00
ESP320⚠️ +520.000.00💚 -160💚 -0.040.00
Click to expand the detailed deltas report [usage change in BYTES]
TargetESP32S3ESP32S2ESP32C3ESP32C6ESP32H2ESP32
ExampleFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAMFLASHRAM
ArduinoOTA/examples/BasicOTA00000000--00
AsyncUDP/examples/AsyncUDPClient00000000--00
AsyncUDP/examples/AsyncUDPMulticastServer00000000--00
AsyncUDP/examples/AsyncUDPServer00000000--00
BLE/examples/BLE5_extended_scan00--000000--
BLE/examples/BLE5_multi_advertising00--000000--
BLE/examples/BLE5_periodic_advertising00--000000--
BLE/examples/BLE5_periodic_sync00--000000--
BLE/examples/Beacon_Scanner00--00000000
BLE/examples/Client00--00000000
BLE/examples/EddystoneTLM_Beacon00--0000--00
BLE/examples/EddystoneURL_Beacon00--0000--00
BLE/examples/Notify00--00000000
BLE/examples/Scan00--00000000
BLE/examples/Server00--00000000
BLE/examples/Server_multiconnect00--00000000
BLE/examples/UART00--00000000
BLE/examples/Write00--00000000
BLE/examples/iBeacon00--00000000
DNSServer/examples/CaptivePortal00000000--00
EEPROM/examples/eeprom_class000000000000
EEPROM/examples/eeprom_extra000000000000
EEPROM/examples/eeprom_write000000000000
ESP32/examples/AnalogOut/LEDCFade000000000000
ESP32/examples/AnalogOut/LEDCSoftwareFade000000000000
ESP32/examples/AnalogOut/SigmaDelta000000000000
ESP32/examples/AnalogOut/ledcFrequency000000000000
ESP32/examples/AnalogOut/ledcWrite_RGB000000000000
ESP32/examples/AnalogRead000000000000
ESP32/examples/AnalogReadContinuous000000000000
ESP32/examples/ArduinoStackSize000000000000
ESP32/examples/CI/CIBoardsTest000000000000
ESP32/examples/Camera/CameraWebServer0000------00
ESP32/examples/ChipID/GetChipID000000000000
ESP32/examples/DeepSleep/ExternalWakeUp0000------00
ESP32/examples/DeepSleep/TimerWakeUp00000000--00
ESP32/examples/DeepSleep/TouchWakeUp0000------00
ESP32/examples/FreeRTOS/BasicMultiThreading000000000000
ESP32/examples/FreeRTOS/Mutex000000000000
ESP32/examples/FreeRTOS/Queue000000000000
ESP32/examples/FreeRTOS/Semaphore000000000000
ESP32/examples/GPIO/BlinkRGB000000000000
ESP32/examples/GPIO/FunctionalInterrupt000000000000
ESP32/examples/GPIO/FunctionalInterruptStruct000000000000
ESP32/examples/GPIO/GPIOInterrupt000000000000
ESP32/examples/HWCDC_Events00--000000--
ESP32/examples/MacAddress/GetMacAddress000000000000
ESP32/examples/RMT/RMTCallback000000000000
ESP32/examples/RMT/RMTLoopback000000000000
ESP32/examples/RMT/RMTReadXJT000000000000
ESP32/examples/RMT/RMTWriteNeoPixel000000000000
ESP32/examples/RMT/RMT_CPUFreq_Test000000000000
ESP32/examples/RMT/RMT_EndOfTransmissionState000000000000
ESP32/examples/RMT/RMT_LED_Blink000000000000
ESP32/examples/ResetReason/ResetReason000000000000
ESP32/examples/ResetReason/ResetReason2000000000000
ESP32/examples/Serial/BaudRateDetect_Demo000000000000
ESP32/examples/Serial/OnReceiveError_BREAK_Demo000000000000
ESP32/examples/Serial/OnReceive_Demo000000000000
ESP32/examples/Serial/RS485_Echo_Demo000000000000
ESP32/examples/Serial/RxFIFOFull_Demo000000000000
ESP32/examples/Serial/RxTimeout_Demo000000000000
ESP32/examples/Serial/Serial_All_CPU_Freqs000000000000
ESP32/examples/Serial/Serial_STD_Func_OnReceive000000000000
ESP32/examples/Serial/onReceiveExample000000000000
ESP32/examples/TWAI/TWAIreceive000000000000
ESP32/examples/TWAI/TWAItransmit000000000000
ESP32/examples/Template/ExampleTemplate000000000000
ESP32/examples/Time/SimpleTime00000000--00
ESP32/examples/Timer/RepeatTimer000000000000
ESP32/examples/Timer/WatchdogTimer000000000000
ESP32/examples/Touch/TouchButtonV20000--------
ESP32/examples/Touch/TouchInterrupt0000------00
ESP32/examples/Touch/TouchRead0000------00
ESP32/examples/Utilities/HEXBuilder000000000000
ESP32/examples/Utilities/MD5Builder000000000000
ESP32/examples/Utilities/SHA1Builder000000000000
ESP_I2S/examples/ES8388_loopback000000000000
ESP_I2S/examples/Record_to_WAV00--------00
ESP_I2S/examples/Simple_tone000000000000
ESP_NOW/examples/ESP_NOW_Broadcast_Master00000000--00
ESP_NOW/examples/ESP_NOW_Broadcast_Slave00000000--00
ESP_NOW/examples/ESP_NOW_Network00000000--00
ESP_NOW/examples/ESP_NOW_Serial00000000--00
ESP_SR/examples/Basic00----------
ESPmDNS/examples/mDNS-SD_Extended00000000--00
ESPmDNS/examples/mDNS_Web_Server00000000--00
Ethernet/examples/ETH_W5500_Arduino_SPI000000000000
Ethernet/examples/ETH_W5500_IDF_SPI000000000000
FFat/examples/FFat_Test000000000000
FFat/examples/FFat_time00000000--00
HTTPClient/examples/Authorization⚠️ +400⚠️ +440⚠️ +940⚠️ +940--⚠️ +480
HTTPClient/examples/BasicHttpClient⚠️ +400⚠️ +440⚠️ +940⚠️ +940--⚠️ +480
HTTPClient/examples/BasicHttpsClient⚠️ +400⚠️ +480⚠️ +940⚠️ +940--⚠️ +480
HTTPClient/examples/HTTPClientEnterprise⚠️ +240⚠️ +520⚠️ +940⚠️ +940--⚠️ +520
HTTPClient/examples/ReuseConnection⚠️ +440⚠️ +440⚠️ +940⚠️ +940--⚠️ +520
HTTPClient/examples/StreamHttpClient⚠️ +400⚠️ +400⚠️ +940⚠️ +940--⚠️ +360
HTTPUpdate/examples/httpUpdate00000000--00
HTTPUpdate/examples/httpUpdateSPIFFS00000000--00
HTTPUpdate/examples/httpUpdateSecure⚠️ +280⚠️ +560⚠️ +940⚠️ +940--⚠️ +520
HTTPUpdateServer/examples/WebUpdater00000000--00
Insights/examples/DiagnosticsSmokeTest000000----00
Insights/examples/MinimalDiagnostics000000----00
LittleFS/examples/LITTLEFS_test000000000000
LittleFS/examples/LITTLEFS_time00000000--00
NetBIOS/examples/ESP_NBNST00000000--00
NetworkClientSecure/examples/WiFiClientInsecure⚠️ +400⚠️ +440⚠️ +940⚠️ +94💚 -16--⚠️ +48💚 -16
NetworkClientSecure/examples/WiFiClientPSK⚠️ +40💚 -16⚠️ +44💚 -16⚠️ +94💚 -16⚠️ +94💚 -16--⚠️ +360
NetworkClientSecure/examples/WiFiClientSecure⚠️ +400⚠️ +440⚠️ +940⚠️ +94💚 -16--⚠️ +48💚 -16
NetworkClientSecure/examples/WiFiClientSecureEnterprise⚠️ +440⚠️ +52💚 -16⚠️ +94💚 -16⚠️ +94💚 -16--⚠️ +48💚 -16
NetworkClientSecure/examples/WiFiClientSecureProtocolUpgrade⚠️ +440⚠️ +520⚠️ +940⚠️ +94💚 -16--⚠️ +48💚 -16
NetworkClientSecure/examples/WiFiClientShowPeerCredentials⚠️ +360⚠️ +480⚠️ +940⚠️ +940--⚠️ +480
NetworkClientSecure/examples/WiFiClientTrustOnFirstUse⚠️ +40💚 -16⚠️ +48💚 -16⚠️ +940⚠️ +940--⚠️ +48💚 -16
PPP/examples/PPP_Basic000000000000
Preferences/examples/Prefs2Struct000000000000
Preferences/examples/StartCounter000000000000
RainMaker/examples/RMakerCustom000000----00
RainMaker/examples/RMakerCustomAirCooler000000----00
RainMaker/examples/RMakerSonoffDualR3000000----00
RainMaker/examples/RMakerSwitch000000----00
SD/examples/SD_Test000000000000
SD/examples/SD_time00000000--00
SD_MMC/examples/SDMMC_Test00--------00
SD_MMC/examples/SDMMC_time00--------00
SPI/examples/SPI_Multiple_Buses0000------00
SPIFFS/examples/SPIFFS_Test000000000000
SPIFFS/examples/SPIFFS_time00000000--00
SimpleBLE/examples/SimpleBleDevice00----000000
TFLiteMicro/examples/hello_world000000000000
Ticker/examples/Blinker000000000000
Ticker/examples/TickerBasic000000000000
Ticker/examples/TickerParameter000000000000
USB/examples/CompositeDevice0000--------
USB/examples/ConsumerControl0000--------
USB/examples/CustomHIDDevice0000--------
USB/examples/FirmwareMSC0000--------
USB/examples/Gamepad0000--------
USB/examples/HIDVendor0000--------
USB/examples/Keyboard/KeyboardLogout0000--------
USB/examples/Keyboard/KeyboardMessage0000--------
USB/examples/Keyboard/KeyboardReprogram0000--------
USB/examples/Keyboard/KeyboardSerial0000--------
USB/examples/KeyboardAndMouseControl0000--------
USB/examples/MIDI/MidiController0000--------
USB/examples/MIDI/MidiInterface0000--------
USB/examples/MIDI/MidiMusicBox0000--------
USB/examples/MIDI/ReceiveMidi0000--------
USB/examples/Mouse/ButtonMouseControl0000--------
USB/examples/SystemControl0000--------
USB/examples/USBMSC0000--------
USB/examples/USBSerial0000--------
USB/examples/USBVendor0000--------
Update/examples/AWS_S3_OTA_Update00000000--00
Update/examples/HTTPS_OTA_Update00000000--00
Update/examples/HTTP_Client_AES_OTA_Update00000000--00
Update/examples/HTTP_Server_AES_OTA_Update00000000--00
Update/examples/OTAWebUpdater00000000--00
Update/examples/SD_Update000000000000
WebServer/examples/AdvancedWebServer00000000--00
WebServer/examples/FSBrowser00000000--00
WebServer/examples/HelloServer00000000--00
WebServer/examples/HttpAdvancedAuth00000000--00
WebServer/examples/HttpAuthCallback00000000--00
WebServer/examples/HttpAuthCallbackInline00000000--00
WebServer/examples/HttpBasicAuth00000000--00
WebServer/examples/HttpBasicAuthSHA100000000--00
WebServer/examples/HttpBasicAuthSHA1orBearerToken00000000--00
WebServer/examples/MultiHomedServers00000000--00
WebServer/examples/PathArgServer00000000--00
WebServer/examples/SDWebServer00000000--00
WebServer/examples/SimpleAuthentification00000000--00
WebServer/examples/UploadHugeFile00000000--00
WebServer/examples/WebServer00000000--00
WebServer/examples/WebUpdate00000000--00
WiFi/examples/FTM/FTM_Initiator00000000--00
WiFi/examples/FTM/FTM_Responder00000000--00
WiFi/examples/SimpleWiFiServer00000000--00
WiFi/examples/WPS00000000--00
WiFi/examples/WiFiAccessPoint00000000--00
WiFi/examples/WiFiBlueToothSwitch00--0000--00
WiFi/examples/WiFiClient00000000--00
WiFi/examples/WiFiClientBasic00000000--00
WiFi/examples/WiFiClientConnect00000000--00
WiFi/examples/WiFiClientEnterprise00000000--00
WiFi/examples/WiFiClientEvents00000000--00
WiFi/examples/WiFiClientStaticIP00000000--00
WiFi/examples/WiFiIPv600000000--00
WiFi/examples/WiFiMulti00000000--00
WiFi/examples/WiFiMultiAdvanced⚠️ +320⚠️ +480⚠️ +940⚠️ +940--⚠️ +480
WiFi/examples/WiFiScan00000000--00
WiFi/examples/WiFiScanAsync00000000--00
WiFi/examples/WiFiScanDualAntenna00000000--00
WiFi/examples/WiFiSmartConfig00000000--00
WiFi/examples/WiFiTelnetToSerial00000000--00
WiFi/examples/WiFiUDPClient00000000--00
WiFiProv/examples/WiFiProv00000000--00
Wire/examples/WireMaster000000000000
Wire/examples/WireScan000000000000
Wire/examples/WireSlave000000000000
BluetoothSerial/examples/DiscoverConnect----------00
BluetoothSerial/examples/GetLocalMAC----------00
BluetoothSerial/examples/SerialToSerialBT----------00
BluetoothSerial/examples/SerialToSerialBTM----------00
BluetoothSerial/examples/SerialToSerialBT_Legacy----------00
BluetoothSerial/examples/SerialToSerialBT_SSP----------00
BluetoothSerial/examples/bt_classic_device_discovery----------00
BluetoothSerial/examples/bt_remove_paired_devices----------00
ESP32/examples/DeepSleep/SmoothBlink_ULP_Code----------00
ESP32/examples/Touch/TouchButton----------00
Ethernet/examples/ETH_LAN8720----------00
Ethernet/examples/ETH_TLK110----------00

@me-no-dev me-no-dev added this to the 3.0.0-RC3 milestone May 15, 2024
@me-no-dev me-no-dev merged commit 3d92ede into espressif:master May 15, 2024
234 checks passed
@JAndrassy JAndrassy deleted the clientsecure_improvements branch May 15, 2024 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@me-no-dev me-no-dev me-no-dev left review comments

Assignees
No one assigned
Labels
Status: Pending Merge Pull Request is ready to be merged
Projects
None yet
Milestone
3.0.0-RC3
Development

Successfully merging this pull request may close these issues.
2 participants
@JAndrassy @me-no-dev