websockets: Use AuthenticationMiddleware #2320

schlimmchen · 2024-09-30T13:58:36Z

with ESPAsyncWebServer 3.3.0, the setAuthentication() method became deprecated and a replacement method was provided which acts as a shim and uses the new middleware-based approach to setup authentication. for unknown reasons, the setAuthentication() method was called periodically. the shim implementation each time allocates a new AuthenticationMiddleware and adds it to the chain of middlewares, eventually exhausting the memory.

we now use the new middleware-based approach ourselves and only add the respective AuthenticatonMiddleware instance once to the respective websocket server instance.

closes #2314.
closes #2316.

tests performed:

websocket is still accessible without authentication if unauthenticated read-only-access is allowed
websocket is only accessible with authentication if unauthenticated read-only-access is disabled
read-only-access setting and/or new password are applied immediately
websocket clients are disconnected when security settings change such that authentication is now reuqired or the password changed.
memory exhaustion when unauthenticated read-only-access is disabled is gone

with ESPAsyncWebServer 3.3.0, the setAuthentication() method became deprecated and a replacement method was provided which acts as a shim and uses the new middleware-based approach to setup authentication. in order to eventually apply a changed "read-only access allowed" setting, the setAuthentication() method was called periodically. the shim implementation each time allocates a new AuthenticationMiddleware and adds it to the chain of middlewares, eventually exhausting the memory. we now use the new middleware-based approach ourselves and only add the respective AuthenticatonMiddleware instance once to the respective websocket server instance. a regression where enabling unauthenticated read-only access is not applied until reboot is also fixed. all the AuthenticationMiddleware instances were never removed from the chain of middlewares when calling setAuthentication("", "").

when changing the security settings (disabling read-only access or changing the password), existing websocket connections are now closed, forcing the respective clients to authenticate (with the new password). otherwise, existing websocket clients keep connected even though the security settings now expect authentication with a (changed) password.

stefan123t · 2024-09-30T14:03:16Z

@schlimmchen you are setting Authentication to DIGEST Auth with Username + Realm ?
Would you want to calculate a hash for the DIGEST too ?
The change has to go into WebApi_ws_console.cpp too, isn't it ?

I would prefer to set it to BASIC Auth and pre-calculate the base64 hash over username:password to spare us the overhead of calculating the hash every time a URL / WebSocket gets called by a Handler.

See these signatures in
https://github.com/mathieucarbou/ESPAsyncWebServer/blob/2e65ee60df093dad4caf2c05c93ae4f897e19b9d/src/ESPAsyncWebServer.h#L287

    // hash is the string representation of:
    //  base64(user:pass) for basic or
    //  user:realm:md5(user:realm:pass) for digest
    bool authenticate(const char* hash);
    bool authenticate(const char* username, const char* password, const char* realm = NULL, bool passwordIsHash = false);

schlimmchen · 2024-09-30T14:14:25Z

to spare us the overhead of calculating the hash every time a URL / WebSocket gets called by a Handler.

IMHO, we should not be concerned about this kind of overhead.

Actually, I would support it if we change all HTTP endpoints to use the new AuthenticationMiddleware implementation, such that DIGEST authentication is the default everywhere.

stefan123t · 2024-09-30T14:42:19Z

See our discussion in #2314 I would assume there are already quite a few projects that also use the Live API for remote displays etc. which would need to switch from BASIC Auth to DIGEST Auth. So I would not vote for this breaking change.

I have explained my doubts regarding the benefits of DIGEST Auth (with fixed Client Nonce) over BASIC Auth on unsecure http connections in the original issue 😉

tbnobody · 2024-09-30T15:09:33Z

Will release a new version this evening and include this PR.

stefan123t

PS: I opened a question upstream with mathieucarbou regarding the performance of recalculating the hashes for every request here:
mathieucarbou/ESPAsyncWebServer#111

stefan123t · 2024-09-30T15:43:44Z

src/WebApi_ws_console.cpp

@@ -21,16 +21,30 @@ void WebApiWsConsoleClass::init(AsyncWebServer& server, Scheduler& scheduler)

    scheduler.addTask(_wsCleanupTask);
    _wsCleanupTask.enable();
+
+    _simpleDigestAuth.setUsername(AUTH_USERNAME);
+    _simpleDigestAuth.setRealm("console websocket");


I would suggest to set it to BASIC Auth here and rename it from _simpleDigestAuth to _simpleBasicAuth for backwards compatibility:

# _simpleDigestAuth.setRealm("console websocket"); _simpleBasicAuth.setAuthType(AuthenticationMiddleware::AuthType::AUTH_BASIC);

stefan123t · 2024-09-30T15:46:00Z

src/WebApi_ws_live.cpp

@@ -36,18 +36,31 @@ void WebApiWsLiveClass::init(AsyncWebServer& server, Scheduler& scheduler)

    scheduler.addTask(_sendDataTask);
    _sendDataTask.enable();
+    _simpleDigestAuth.setUsername(AUTH_USERNAME);
+    _simpleDigestAuth.setRealm("live websocket");


and here ;)

it turns out that authentication was never implemented on OpenDTU-OnBattery-specific websocket connections. found while applying tbnobody#2320

mathieucarbou · 2024-09-30T23:58:37Z

src/WebApi_ws_console.cpp

+
+void WebApiWsConsoleClass::reload()
+{
+    _ws.removeMiddleware(&_simpleDigestAuth);


you don't need to remove the middleware: you can just call _simpleDigestAuth.setAuthMethod(NO_AUTH)

Thanks for commenting here, @mathieucarbou. Your suggestion makes a lot of sense. Could you answer us this: Do we even need multiple instances of the AuthenticationMiddleware if we want to protect all websockets the same? Can we have a single instance and add it to all servers? I guess there will be no problem with BASIC auth, but DIGEST possibly needs request-specific state, so I am not sure whether a static instance can just handle all connections?

One single instance added to the server only will protected globally all handlers (http, ws, sse). But only the initial connection creation!

Eg, if you have some websocket connection opened, and change authentication settings, currently established connection can't be re-authenticated.

mathieucarbou · 2024-10-01T00:03:11Z

FYI I have reworked the Authc middleware - I will release a new version soon once the PR is merged: mathieucarbou/ESPAsyncWebServer#113

There will be some breaking changes but only in the enum and setAuthMethod(), not on the past main APIs.

A method will be added to pre-compute the base64 hash or md5 hash for basic / digest auth.

(as reported in tbnobody/OpenDTU#2320)

mathieucarbou · 2024-10-01T09:13:10Z

I also added a commit ti fix the memory leak (mathieucarbou/ESPAsyncWebServer@041565a)

Please open an issue or PR (even better!) in the project also next time you see something like that ;-)

Thanks!

schlimmchen · 2024-10-01T18:22:55Z

Thanks for your invitation to open an issue against your project in such a case. I would like to add that I did not feel that misusing a deprecated shim would warrant to open an issue and "complain". I think with that bugfix you went out of your way to keep the hassle for the users of your project to a minimum, despite good documentation about the deprecation. Good job 💪

github-actions · 2024-11-01T04:13:12Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

schlimmchen added 2 commits September 30, 2024 15:16

stefan123t mentioned this pull request Sep 30, 2024

openDTU 24.9.27 reboot alle 10min #2314

Closed

4 tasks

stefan123t reviewed Sep 30, 2024

View reviewed changes

tbnobody merged commit aa5087c into tbnobody:master Sep 30, 2024
9 checks passed

schlimmchen deleted the issue-tbnobody#2314 branch September 30, 2024 18:46

stefan123t mentioned this pull request Sep 30, 2024

NavGuard #786

Open

mathieucarbou reviewed Sep 30, 2024

View reviewed changes

mathieucarbou added a commit to mathieucarbou/ESPAsyncWebServer that referenced this pull request Oct 1, 2024

Fix memory leak on successive call to setAuthentication

041565a

(as reported in tbnobody/OpenDTU#2320)

schlimmchen mentioned this pull request Oct 13, 2024

Clean up and improve websocket authentication hoylabs/OpenDTU-OnBattery#1319

Open

stefan123t mentioned this pull request Oct 30, 2024

[Bug] Abfrage der Daten mit MC in MicroPython funktioniert nicht mehr mit Version 0.8.127 lumapu/ahoy#1685

Open

1 task

github-actions bot locked as resolved and limited conversation to collaborators Nov 1, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

websockets: Use AuthenticationMiddleware #2320

websockets: Use AuthenticationMiddleware #2320

schlimmchen commented Sep 30, 2024

stefan123t commented Sep 30, 2024 •

edited

Loading

schlimmchen commented Sep 30, 2024

stefan123t commented Sep 30, 2024

tbnobody commented Sep 30, 2024

stefan123t left a comment

stefan123t Sep 30, 2024

stefan123t Sep 30, 2024

mathieucarbou Sep 30, 2024 •

edited

Loading

schlimmchen Oct 1, 2024

mathieucarbou Oct 1, 2024 •

edited

Loading

mathieucarbou commented Oct 1, 2024

mathieucarbou commented Oct 1, 2024

schlimmchen commented Oct 1, 2024

github-actions bot commented Nov 1, 2024

websockets: Use AuthenticationMiddleware #2320

websockets: Use AuthenticationMiddleware #2320

Conversation

schlimmchen commented Sep 30, 2024

stefan123t commented Sep 30, 2024 • edited Loading

schlimmchen commented Sep 30, 2024

stefan123t commented Sep 30, 2024

tbnobody commented Sep 30, 2024

stefan123t left a comment

Choose a reason for hiding this comment

stefan123t Sep 30, 2024

Choose a reason for hiding this comment

stefan123t Sep 30, 2024

Choose a reason for hiding this comment

mathieucarbou Sep 30, 2024 • edited Loading

Choose a reason for hiding this comment

schlimmchen Oct 1, 2024

Choose a reason for hiding this comment

mathieucarbou Oct 1, 2024 • edited Loading

Choose a reason for hiding this comment

mathieucarbou commented Oct 1, 2024

mathieucarbou commented Oct 1, 2024

schlimmchen commented Oct 1, 2024

github-actions bot commented Nov 1, 2024

stefan123t commented Sep 30, 2024 •

edited

Loading

mathieucarbou Sep 30, 2024 •

edited

Loading

mathieucarbou Oct 1, 2024 •

edited

Loading