Skip to content

WiFiServerSecure: Cache SSL sessions #7774

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

Merged
merged 9 commits into from
Dec 22, 2020
Merged

WiFiServerSecure: Cache SSL sessions #7774

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a0b5567
WiFiServerSecure: Cache the SSL sessions
ZakCodes Jul 19, 2020
fd5662b
Add SSL session caching to HTTPS server examples
ZakCodes Jul 19, 2020
420bc77
Document server SSL session caching
ZakCodes Jul 19, 2020
c7e6407
Fix an incomplete sentence in the documentation
ZakCodes Jul 19, 2020
f822ed2
Document BearSSL::Session
ZakCodes Jul 19, 2020
408ed5c
Use the number of sessions instead of the buffer size in ServerSessio…
ZakCodes Dec 20, 2020
3eaa456
Merge branch 'master' into server-ssl-sessions
earlephilhower Dec 20, 2020
15fa68d
Merge branch 'master' into server-ssl-sessions
earlephilhower Dec 22, 2020
fb5e30a
Merge branch 'master' into server-ssl-sessions
earlephilhower Dec 22, 2020
File filter

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add SSL session caching to HTTPS server examples
  • Loading branch information
@ZakCodes
ZakCodes committed Dec 17, 2020
commit fd5662be5d4e4d55f8ad165d553619cdcc6c5348
4 changes: 4 additions & 0 deletions libraries/ESP8266WebServer/examples/HelloServerBearSSL/HelloServerBearSSL.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ const char* ssid = STASSID;
const char* password = STAPSK;

BearSSL::ESP8266WebServerSecure server(443);
BearSSL::ServerSessions serverCache(500);

static const char serverCert[] PROGMEM = R"EOF(
-----BEGIN CERTIFICATE-----
Expand Down Expand Up @@ -132,6 +133,9 @@ void setup(void){

server.getServer().setRSACert(new BearSSL::X509List(serverCert), new BearSSL::PrivateKey(serverKey));

// Cache SSL sessions to accelerate the TLS handshake.
server.getServer().setCache(&serverCache);

server.on("/", handleRoot);

server.on("/inline", [](){
Expand Down
22 changes: 22 additions & 0 deletions libraries/ESP8266WiFi/examples/BearSSL_Server/BearSSL_Server.ino
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,23 @@ GBEnkz4KpKv7TkHoW+j7F5EMcLcSrUIpyw==

#endif

#define CACHE_SIZE 500 // Size of the cache for SSL sessions.
// Each SSL session requires 100 bytes,
// so 500 is enough for 5 sessions.
#define USE_CACHE // Enable SSL session caching.
// Caching SSL sessions shortens the length of the SSL handshake.
// You can see the performance improvement by looking at the
// Network tab of the developper tools of your browser.
//#define DYNAMIC_CACHE // Whether to dynamically allocate the cache.

#if defined(USE_CACHE) && defined(DYNAMIC_CACHE)
// Dynamically allocated cache.
BearSSL::ServerSessions serverCache(STORE, CACHE_SIZE);
#elif defined(USE_CACHE)
// Statically allocated cache.
uint8_t store[CACHE_SIZE];
BearSSL::ServerSessions serverCache(CACHE_SIZE);
#endif

void setup() {
Serial.begin(115200);
Expand Down Expand Up @@ -169,6 +186,11 @@ void setup() {
server.setECCert(serverCertList, BR_KEYTYPE_KEYX|BR_KEYTYPE_SIGN, serverPrivKey);
#endif

// Set the server's cache
#if defined(USE_CACHE)
server.setCache(&serverCache);
#endif

// Actually start accepting connections
server.begin();
}
Expand Down