Arduino ESP8266 DNSServer.h
ESP8266 DNSServer——真正的域名服务
来源1
来源2
- 名转成对应映射的地址
1.2 DNS server库
ESP8266使用DNS服务(一般和WebServer服务一起使用,WebServer请回顾 ESP8266开发之旅 网络篇⑪ WebServer——ESP8266WebServer库的使用),请在代码中加入以下头文件:
#include <DNSServer.h>
讲解方法之前,先来看看博主总结的百度脑图:
常用方法非常简单,就4个方法,毕竟DNS服务器的功能比较单一。
1.2.1 start —— 启动DNS服务器
函数说明:
/** * 启动DNS服务器 * @param port 端口号 DNS端口一般占用53 * @param domainName 映射域名 * @param resolvedIP 映射IP地址 * @return bool 是否启动成功 */ bool start(const uint16_t &port, const String &domainName, const IPAddress &resolvedIP);
源码说明:
bool DNSServer::start(const uint16_t &port, const String &domainName, const IPAddress &resolvedIP) { _port = port; _buffer = NULL; _domainName = domainName; _resolvedIP[0] = resolvedIP[0]; _resolvedIP[1] = resolvedIP[1]; _resolvedIP[2] = resolvedIP[2]; _resolvedIP[3] = resolvedIP[3]; downcaseAndRemoveWwwPrefix(_domainName); //启动了UDP服务 监听客户端向DNS服务器查询域名 return _udp.begin(_port) == 1; }
1.2.2 stop —— 停止DNS服务器
函数说明:
/** * 停止DNS服务器 */ void stop();
源码说明:
void DNSServer::stop() { //停止udp服务 _udp.stop(); free(_buffer); _buffer = NULL; }
1.2.3 setErrorReplyCode —— 设置错误响应码
函数说明:
/** * 设置错误响应码 * @param DNSReplyCode 错误响应码 */ void setErrorReplyCode(const DNSReplyCode &replyCode);
DNSReplyCode 定义如下:
enum class DNSReplyCode { NoError = 0, FormError = 1, ServerFailure = 2, //服务错误 NonExistentDomain = 3, NotImplemented = 4,//未定义 Refused = 5,//拒绝访问 YXDomain = 6, YXRRSet = 7, NXRRSet = 8 };
1.2.4 processNextRequest —— 处理DNS请求服务
函数说明:
/** * 处理DNS请求服务 */ void processNextRequest();
源码说明:
/** * 处理DNS请求服务 */ void DNSServer::processNextRequest() { //获取UDP请求内容 _currentPacketSize = _udp.parsePacket(); if (_currentPacketSize) { if (_buffer != NULL) free(_buffer); _buffer = (unsigned char*)malloc(_currentPacketSize * sizeof(char)); if (_buffer == NULL) return; _udp.read(_buffer, _currentPacketSize); _dnsHeader = (DNSHeader*) _buffer; //判断请求是否查找域名映射的IP地址 *在这里有非常特殊作用 读者请注意 if (_dnsHeader->QR == DNS_QR_QUERY && _dnsHeader->OPCode == DNS_OPCODE_QUERY && requestIncludesOnlyOneQuestion() && (_domainName == "*" || getDomainNameWithoutWwwPrefix() == _domainName) ) { //返回IP地址 replyWithIP(); } else if (_dnsHeader->QR == DNS_QR_QUERY) { //响应错误码 replyWithCustomCode(); } free(_buffer); _buffer = NULL; } } /** * 响应域名对应的IP地址 */ void DNSServer::replyWithIP() { if (_buffer == NULL) return; _dnsHeader->QR = DNS_QR_RESPONSE; _dnsHeader->ANCount = _dnsHeader->QDCount; _dnsHeader->QDCount = _dnsHeader->QDCount; //_dnsHeader->RA = 1; _udp.beginPacket(_udp.remoteIP(), _udp.remotePort()); _udp.write(_buffer, _currentPacketSize); _udp.write((uint8_t)192); // answer name is a pointer _udp.write((uint8_t)12); // pointer to offset at 0x00c _udp.write((uint8_t)0); // 0x0001 answer is type A query (host address) _udp.write((uint8_t)1); _udp.write((uint8_t)0); //0x0001 answer is class IN (internet address) _udp.write((uint8_t)1); _udp.write((unsigned char*)&_ttl, 4); // Length of RData is 4 bytes (because, in this case, RData is IPv4) _udp.write((uint8_t)0); _udp.write((uint8_t)4); _udp.write(_resolvedIP, sizeof(_resolvedIP)); _udp.endPacket(); #ifdef DEBUG_ESP_DNS DEBUG_ESP_PORT.printf("DNS responds: %s for %s\n", IPAddress(_resolvedIP).toString().c_str(), getDomainNameWithoutWwwPrefix().c_str() ); #endif } /** * 响应错误码 */ void DNSServer::replyWithCustomCode() { if (_buffer == NULL) return; _dnsHeader->QR = DNS_QR_RESPONSE; _dnsHeader->RCode = (unsigned char)_errorReplyCode; _dnsHeader->QDCount = 0; _udp.beginPacket(_udp.remoteIP(), _udp.remotePort()); _udp.write(_buffer, sizeof(DNSHeader)); _udp.endPacket(); }
注意点:
- ESP8266 DNSServer 运行于UDP协议之上;
- ESP8266 DNSServer只能支持一个域名映射;
- 当ESP8266设置的域名为“*”,意味着所有请求都会被链接到该IP地址,我们可以利用这一点做一些特殊操作;
1.3 实例
1.3.1 访问主机名
实验说明
在手机浏览器访问 "www.danpianji.com"会显示“Hello World”
实验源码
/** * 功能描述:在手机浏览器访问 "www.danpianji.com"会显示“Hello World” */ #include <ESP8266WiFi.h> #include <DNSServer.h> #include <ESP8266WebServer.h> //调试定义 #define DebugBegin(baud_rate) Serial.begin(baud_rate) #define DebugPrintln(message) Serial.println(message) #define DebugPrint(message) Serial.print(message) #define DebugPrintF(...) Serial.printf( __VA_ARGS__ ) const byte DNS_PORT = 53; IPAddress apIP(192, 168, 1, 1); DNSServer dnsServer; ESP8266WebServer webServer(80); void setup() { DebugBegin(115200); WiFi.mode(WIFI_AP); WiFi.softAPConfig(apIP, apIP, IPAddress(255, 255, 255, 0)); WiFi.softAP("DNSServer example"); // modify TTL associated with the domain name (in seconds) // default is 60 seconds dnsServer.setTTL(300); // set which return code will be used for all other domains (e.g. sending // ServerFailure instead of NonExistentDomain will reduce number of queries // sent by clients) // default is DNSReplyCode::NonExistentDomain dnsServer.setErrorReplyCode(DNSReplyCode::ServerFailure); // 启动DNS server,映射主机名为 www.danpianji.com bool status = dnsServer.start(DNS_PORT, "www.danpianji.com", apIP); if(status){ DebugPrintln("start dnsserver success."); }else{ DebugPrintln("start dnsserver failed."); } // simple HTTP server to see that DNS server is working webServer.onNotFound([]() { String message = "Hello World!\n\n"; message += "URI: "; message += webServer.uri(); webServer.send(200, "text/plain", message); }); webServer.begin(); } void loop() { dnsServer.processNextRequest(); webServer.handleClient(); }
实验结果
会看到一个DNSServer example开放式AP热点,连接上:
然后在手机浏览器访问 www.danpianji.com
1.3.2 Portal 认证
实验说明
通常,当我们连上一些wifi热点,只要没有认证手机号码信息,无论访问哪个页面都会弹出一个web认证页面(这就是商家用来收集手机用户信息的一种手段,慎重),这就是 Portal 认证。
Portal服务器也就是接收Portal客户端认证请求的服务器端系统,其主要作用是提供免费的门户服务和基于Web认证的界面,以及接入设备交互认证客户端的认证信息。其中的Web认证方案首先需要给用户分配一个地址,用于访问门户网站。
Portal 基于浏览器,采用的是B/S构架, 对不同权限的用户下发不同的VLAN 访问不同的服务器资源,当通过认证后才能访问internet资源,Portal认证方式不需要安装认证客户端, 减少了客户端的维护工作量,便于运营。
可以在Portal页面上开展业务拓展,如展示商家广告, 联系方式等基本信息。Portal广泛应用于运营商、学校等网络。
通过DNSServer,我们也可以使用到Portal认证
实验源码
/** * 功能描述:portal认证 */ #include <DNSServer.h> #include <ESP8266WebServer.h> #include <ESP8266WiFi.h> //调试定义 #define DebugBegin(baud_rate) Serial.begin(baud_rate) #define DebugPrintln(message) Serial.println(message) #define DebugPrint(message) Serial.print(message) #define DebugPrintF(...) Serial.printf( __VA_ARGS__ ) const byte DNS_PORT = 53; IPAddress apIP(192, 168, 1, 1); DNSServer dnsServer; ESP8266WebServer webServer(80); String responseHTML = "" "<!DOCTYPE html><html><head><title>CaptivePortal</title></head><body>" "<h1>Hello World!</h1><p>This is a captive portal example. All requests will " "be redirected here.</p></body></html>"; void setup() { DebugBegin(115200); WiFi.mode(WIFI_AP); WiFi.softAPConfig(apIP, apIP, IPAddress(255, 255, 255, 0)); WiFi.softAP("DNSServer CaptivePortal example"); // 所有请求都映射到一个具体地址 dnsServer.start(DNS_PORT, "*", apIP); // replay to all requests with same HTML webServer.onNotFound([]() { DebugPrintln("webServer handle."); webServer.send(200, "text/html", responseHTML); }); webServer.begin(); } void loop() { dnsServer.processNextRequest(); webServer.handleClient(); }
实验结果 会看到一个 DNSServer CaptivePortal example 开放式AP热点,连接上:
然后在手机浏览器访问 www.danpianji.com
1.4 总结
DNSServer也是相对来说非常重要的一章,特别对于web配网,需要使用到它,请读者认真理解使用。