Authentication

WebSerial supports HTTP Basic Authentication. Enable it to ensure that only authorized users can view the logs of your device and send commands to it.

Enable authenticationCopy Anchor Link

Call setAuthentication() with a username and password:

WebSerial.setAuthentication("username", "password");

When authentication is enabled, WebSerial requires the credentials both for the terminal page and for the WebSocket connection that carries the log output.

ExampleCopy Anchor Link

#include <WebSerial.h>

// ...

void setup() {
  // ...

  WebSerial.begin(&server);

  // Require credentials to access the terminal
  WebSerial.setAuthentication("myUsername", "myPassword");

  server.begin();
}

void loop() {
  // ...
  WebSerial.loop();
}

NotesCopy Anchor Link

• Authentication is enabled only when both the username and the password are non-empty. Pass empty strings to disable it.
• setAuthentication() can be called before or after begin().
• HTTP Basic Authentication does not encrypt traffic. Use strong, unique credentials for each device and do not reuse default or easily guessable credentials.