ESP8266 – ESP8266WebServer库 – requestAuthentication

位置导航: ESP8266库 / ESP8266WebServer库 / 本页

语法

在ESP8266开发板所建立的物联网服务器在运行过程中，如果有客户端向服务器发送HTTP请求，服务器可使用本函数向客户端发送认证请求,从而建立需要用户名和密码认证的加密网页服务器。只有当客户端请求信息中包含正确的认证请求方可访问网页信息。

请注意，与此函数配套使用的是authenticate函数。authenticate用于设置与校验客户端请求信息中的用户名和密码。而requestAuthentication用于向客户端发送认证请求。

语法

server.requestAuthentication(mode, realm, authFailMsg)
server.requestAuthentication()

参数

mode (可选参数)
– HTTP验证方式
– 可选关键词：BASIC_AUTH、 DIGEST_AUTH（不填则默认为BASIC_AUTH）

realm (可选参数)
– 认证范围
– 参数类型: const char\* (不填则默认为空NULL)

authFailMsg (可选参数)
– 认证失败提示消息
– 参数类型: const String
– 不填则默认为空字符串 String(“”)

返回值

无

示例程序

当您将WiFi连接信息修改后并且将本示例程序上传ESP8266开发板后，开发板随即会自动连接WiFi。WiFi连接成功后，您将可以从串口监视器获取当前ESP8266开发板的IP。

接下来您可以通过浏览器地址栏输入ESP8266开发板的IP地址并键入回车（即向ESP8266开发板所建立的物联网服务器发送一个GET请求）。

接下来浏览器将会弹出对话框，要求用户输入用户名:TaichiMaker和密码:123456。如下图所示。

只有当用户正确输入了用户名和密码信息以后，方可打开ESP8266开发板建立的网站页面。（如下图所示）

以下示例程序中的高亮语句server.requestAuthentication()要求客户端发送打开网页的用户名和密码。

/**********************************************************************
  项目名称/Project          : 零基础入门学用物联网
  程序名称/Program name     : WebServer_demo_requestAuthentication
  团队/Team                : 太极创客团队 / Taichi-Maker (www.taichi-maker.com)
  作者/Author              : Dapenson
  日期/Date（YYYYMMDD）     : 20200325
  程序目的/Purpose          :
  使用8266作为WebServer,并用浏览器打开设备IP+80端口进行访问
  在登录主页时使用认证方式登录,登录账户密码分别为(TaichiMaker/123456)
  -----------------------------------------------------------------------
  本示例程序为太极创客团队制作的《零基础入门学用物联网》中示例程序。
  该教程为对物联网开发感兴趣的朋友所设计和制作。如需了解更多该教程的信息，请参考以下网页：
  http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/
***********************************************************************/
#include <ESP8266WiFi.h>
#include <ESP8266WebServer.h>

//设置WiFi接入信息
const char* ssid = "TaichiMaker";
const char* password = "xxxxxxxx";

ESP8266WebServer server(80);

//设置需要收集的请求头信息
const char *headerKeys[] = {"Content-Length", "Content-Type", "Connection", "Date"};

// 设置主页请求处理函数
void homepage() {

  //校验用户登录账号和密码,(默认使用Basic方式),若输入错误则继续返回认证界面
  if (!server.authenticate("TaichiMaker", "123456")) 
  return server.requestAuthentication();

  server.send(200, "text/plain", "test homepage");
  Serial.println("用户访问了主页");
}

// 设置处理404情况的函数'handleNotFound'
void handleNotFound() {                                       // 当浏览器请求的网络资源无法在服务器找到时，
  server.send(404, "text/plain", "404: Not found");           // NodeMCU将调用此函数。
}

void setup(void) {
  //初始化串口
  Serial.begin(115200);
  Serial.println("");

  //初始化网络
  WiFi.mode(WIFI_STA);
  WiFi.begin(ssid, password);
  while (WiFi.status() != WL_CONNECTED) {
    delay(500);
    Serial.print(".");
  }
  Serial.println("");
  Serial.print("IP Address: ");
  Serial.println(WiFi.localIP());

  //初始化WebServer
  server.begin();
  //设置主页处理函数
  server.on("/", homepage);
  //设置404页面
  server.onNotFound(handleNotFound);
  //串口输出服务器准备完成信息
  Serial.println("HTTP server started");
}

void loop(void) {
  //监听客户请求并处理
  server.handleClient();
}

/**********************************************************************

项目名称/Project : 零基础入门学用物联网

程序名称/Program name : WebServer_demo_requestAuthentication

团队/Team : 太极创客团队 / Taichi-Maker (www.taichi-maker.com)

作者/Author : Dapenson

日期/Date（YYYYMMDD） : 20200325

程序目的/Purpose :

使用8266作为WebServer,并用浏览器打开设备IP+80端口进行访问

在登录主页时使用认证方式登录,登录账户密码分别为(TaichiMaker/123456)

-----------------------------------------------------------------------

本示例程序为太极创客团队制作的《零基础入门学用物联网》中示例程序。

该教程为对物联网开发感兴趣的朋友所设计和制作。如需了解更多该教程的信息，请参考以下网页：

http://www.taichi-maker.com/homepage/esp8266-nodemcu-iot/

***********************************************************************/

#include <ESP8266WiFi.h>

#include <ESP8266WebServer.h>

//设置WiFi接入信息

const char* ssid = "TaichiMaker";

const char* password = "xxxxxxxx";

ESP8266WebServer server(80);

//设置需要收集的请求头信息

const char *headerKeys[] = {"Content-Length", "Content-Type", "Connection", "Date"};

// 设置主页请求处理函数

void homepage() {

//校验用户登录账号和密码,(默认使用Basic方式),若输入错误则继续返回认证界面

if (!server.authenticate("TaichiMaker", "123456"))

return server.requestAuthentication();

server.send(200, "text/plain", "test homepage");

Serial.println("用户访问了主页");

}

// 设置处理404情况的函数'handleNotFound'

void handleNotFound() { // 当浏览器请求的网络资源无法在服务器找到时，

server.send(404, "text/plain", "404: Not found"); // NodeMCU将调用此函数。

}

void setup(void) {

//初始化串口

Serial.begin(115200);

Serial.println("");

//初始化网络

WiFi.mode(WIFI_STA);

WiFi.begin(ssid, password);

while (WiFi.status() != WL_CONNECTED) {

delay(500);

Serial.print(".");

}

Serial.println("");

Serial.print("IP Address: ");

Serial.println(WiFi.localIP());

//初始化WebServer

server.begin();

//设置主页处理函数

server.on("/", homepage);

//设置404页面

server.onNotFound(handleNotFound);

//串口输出服务器准备完成信息

Serial.println("HTTP server started");

}

void loop(void) {

//监听客户请求并处理

server.handleClient();

}

语法

语法

参数

返回值

示例程序

相关内容